This directory contains comprehensive documentation for the MarkItDown MCP server.
API documentation and technical specifications
- Tool schemas and parameters
- MCP protocol implementation details
- Response formats and error codes
Development and contribution documentation
- CONTRIBUTING.md - How to contribute to the project
- TESTING_STRATEGY.md - Testing approach and guidelines
- CI_CD_SYSTEM.md - Complete CI/CD architecture and workflows
User guides and troubleshooting
- KNOWN_ISSUES.md - Known issues and workarounds
- Installation guides
- Configuration tutorials
- Main README - Project overview and quick start
- Configuration Examples - MCP client configurations
- Known Issues - Common problems and solutions
- Contributing Guide - How to contribute
- Testing Strategy - Testing approach
- AGENTS Documentation - AI agent integration guide
- Tool Documentation - Detailed tool specifications
- MCP Protocol - Protocol implementation details
This documentation is maintained alongside the codebase. When making changes:
- Update relevant documentation files
- Add new guides for significant features
- Update the changelog for documentation changes
- Ensure examples remain current with code changes
- Use clear, concise language
- Include practical examples
- Keep guides up-to-date with latest features
- Follow Markdown best practices
- Include troubleshooting sections where appropriate