Skip to content

Commit a72ccc1

Browse files
committed
refactor: 删除 README 中重复的链接信息
1 parent 1f6ccbc commit a72ccc1

2 files changed

Lines changed: 0 additions & 104 deletions

File tree

README.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@
1515

1616
MCP (Model Context Protocol) Document Reader - A powerful MCP tool for reading documents in multiple formats, enabling AI agents to truly "read" your documents.
1717

18-
GitHub Repository: [https://github.com/xt765/mcp_documents_reader](https://github.com/xt765/mcp_documents_reader)
19-
20-
Gitee Repository: [https://gitee.com/xt765/mcp_documents_reader](https://gitee.com/xt765/mcp_documents_reader)
21-
22-
PyPI: [https://pypi.org/project/mcp-documents-reader/](https://pypi.org/project/mcp-documents-reader/)
23-
24-
Official Registry: [View on MCP Registry](https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.xt765/mcp_documents_reader)
25-
2618
## Architecture
2719

2820
```mermaid
@@ -176,50 +168,6 @@ Read any supported document type.
176168
|-----------|------|----------|-------------|
177169
| filename | string || Document file path, supports absolute or relative paths |
178170

179-
## Development
180-
181-
### Running Tests
182-
183-
```bash
184-
# Install development dependencies
185-
pip install mcp-documents-reader[dev]
186-
187-
# Run all tests
188-
pytest tests/ -v
189-
190-
# Run tests with coverage
191-
pytest tests/ -v --cov=mcp_documents_reader --cov-report=html
192-
193-
# Or use the test runner script
194-
python scripts/run_tests.py --html
195-
```
196-
197-
### Code Quality
198-
199-
```bash
200-
# Run linter
201-
ruff check .
202-
203-
# Format code
204-
ruff format .
205-
206-
# Type checking
207-
basedpyright .
208-
```
209-
210-
For more details, see [DEVELOPMENT.md](DEVELOPMENT.md)
211-
212-
## CI/CD
213-
214-
This project uses GitHub Actions for continuous integration and deployment:
215-
216-
- **CI**: Runs tests on multiple Python versions (3.8-3.12) and platforms (Ubuntu, Windows, macOS)
217-
- **Code Quality**: Linting with ruff and type checking with basedpyright
218-
- **Security**: Weekly security scans with pip-audit, bandit, and safety
219-
- **Release**: Automatic PyPI publication on version tag push
220-
221-
For release process, see [RELEASE.md](RELEASE.md)
222-
223171
## License
224172

225173
MIT

README.zh-CN.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@
1515

1616
MCP(模型上下文协议)文档读取器 - 一个强大的 MCP 工具,用于读取多种格式的文档,使 AI 智能体能够真正"读取"您的文档。
1717

18-
GitHub 仓库:[https://github.com/xt765/mcp_documents_reader](https://github.com/xt765/mcp_documents_reader)
19-
20-
Gitee 仓库:[https://gitee.com/xt765/mcp_documents_reader](https://gitee.com/xt765/mcp_documents_reader)
21-
22-
PyPI:[https://pypi.org/project/mcp-documents-reader/](https://pypi.org/project/mcp-documents-reader/)
23-
24-
官方注册表:[在 MCP Registry 查看](https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.xt765/mcp_documents_reader)
25-
2618
## 架构
2719

2820
```mermaid
@@ -176,50 +168,6 @@ read_document(filename="example.txt")
176168
|------|------|------|------|
177169
| filename | string || 文档文件路径,支持绝对路径或相对路径 |
178170

179-
## 开发
180-
181-
### 运行测试
182-
183-
```bash
184-
# 安装开发依赖
185-
pip install mcp-documents-reader[dev]
186-
187-
# 运行所有测试
188-
pytest tests/ -v
189-
190-
# 运行测试并生成覆盖率报告
191-
pytest tests/ -v --cov=mcp_documents_reader --cov-report=html
192-
193-
# 或使用测试运行脚本
194-
python scripts/run_tests.py --html
195-
```
196-
197-
### 代码质量
198-
199-
```bash
200-
# 运行代码检查
201-
ruff check .
202-
203-
# 格式化代码
204-
ruff format .
205-
206-
# 类型检查
207-
basedpyright .
208-
```
209-
210-
详细信息请查看 [DEVELOPMENT.md](DEVELOPMENT.md)
211-
212-
## CI/CD
213-
214-
本项目使用 GitHub Actions 进行持续集成和部署:
215-
216-
- **CI**: 在多个 Python 版本(3.8-3.12)和平台(Ubuntu、Windows、macOS)上运行测试
217-
- **代码质量**: 使用 ruff 进行代码检查,使用 basedpyright 进行类型检查
218-
- **安全**: 每周使用 pip-audit、bandit 和 safety 进行安全扫描
219-
- **发布**: 推送版本标签时自动发布到 PyPI
220-
221-
发布流程请查看 [RELEASE.md](RELEASE.md)
222-
223171
## 许可证
224172

225173
MIT

0 commit comments

Comments
 (0)