---
description: Documentation Standards
globs: ["**/*.md", "**/*.py"]
alwaysApply: false
---
# Documentation Standards
## Required Documentation Files
- README.md (project root)
- tests/README.md
- examples/README.md
## Python Documentation
- Use Google-style docstrings for all code
- Document all parameters, return values, and raised exceptions
- Include type hints to aid in documentation
## API Documentation
- API docs should use Sphinx
- Output directory: docs/api
- Use autodoc extensions to generate API docs from docstrings
## Project Documentation
- README.md should include:
- Project description
- Installation instructions
- Basic usage examples
- Configuration options
- Link to more detailed documentation
## Examples
- Provide well-commented examples showing how to use the MCP server
- Each example should be runnable without modification
- Include examples for common use cases
## References
- MCP Protocol: https://modelcontextprotocol.io/llms-full.txt
- Python Style Guide: https://peps.python.org/pep-0008/
- Python SDK: https://github.com/modelcontextprotocol/python-sdk