|
15 | 15 |
|
16 | 16 | MCP (Model Context Protocol) Document Reader - A powerful MCP tool for reading documents in multiple formats, enabling AI agents to truly "read" your documents. |
17 | 17 |
|
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 | | - |
26 | 18 | ## Architecture |
27 | 19 |
|
28 | 20 | ```mermaid |
@@ -176,50 +168,6 @@ Read any supported document type. |
176 | 168 | |-----------|------|----------|-------------| |
177 | 169 | | filename | string | ✅ | Document file path, supports absolute or relative paths | |
178 | 170 |
|
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 | | - |
223 | 171 | ## License |
224 | 172 |
|
225 | 173 | MIT |
0 commit comments