CLAUDE.md for modelcontextprotocol/docs

Guidelines for contributing to the Model Context Protocol documentation. Covers Mintlify setup, MDX formatting, and documentation standards.

RRuleBoxยทvia anthropic
ยทMar 25, 2025ยท57 views
# MCP Documentation Guidelines

## Build Commands
- Preview changes locally: `mintlify dev`
- Deploy: Automatic after PR merge to main branch

## Style Guidelines
- Follow existing MDX formatting and components
- Keep content clear, concise, and technically accurate
- Include practical code examples where appropriate
- Test all links and code samples before submitting
- Maintain consistent structure with existing documentation
- When documenting CLI commands, use two-line format with the prompt on a separate line: `$ claude` followed by `> /command`
- Use appropriate headings: "When to use", "Steps", and "Tips" for tutorials
- Branch naming convention: prefix with "ashwin/" (e.g., "ashwin/add-mcp-cli-docs")

## File Organization
- Place new pages in appropriate sections (concepts, tutorials, etc.)
- Update docs.json when adding new pages
- Follow existing file naming conventions (kebab-case.mdx)
- Include proper frontmatter in MDX files

## Documentation Standards
- Prioritize user understanding over technical completeness
- Document both basic syntax and concrete examples
- Structure command documentation with clear formatting
- For image analysis examples, use quotes: `$ claude "Analyze this image: /path/to/image.png"`

Comments

No comments yet

Be the first to share your thoughts!