Welcome to the Hatch-MCP-Server documentation. This page provides navigation to all available documentation for users, developers, and maintainers.
- Getting Started - Installation, quick start, and basic usage patterns
- API Reference - Complete documentation of the HatchMCP class and methods
- Citation System Guide - Understanding and implementing scientific attribution
- Examples - Practical examples and usage patterns
- Architecture Overview - Design principles, components, and patterns
- Contributing Guide - Development workflow and MCP compatibility requirements
- Glossary - Definitions of key terms and concepts
- FastMCP Documentation - The underlying MCP server framework
- MCP Protocol Specification - Official MCP protocol documentation
- Hatch Ecosystem - The broader Hatch package management system
- GitHub Repository - Source code and issue tracking
- Contributing Guide - Complete development guidelines and workflow
- License - AGPL v3 license information
I want to...
- Use HatchMCP in my project → Start with Getting Started
- Understand citation features → Read Citation System Guide
- Look up API details → Check API Reference
- Contribute to the project → See Contributing Guide
- Understand the architecture → Read Architecture Overview
- Find definitions → Use Glossary
docs/
├── articles/
│ ├── users/ # End-user documentation
│ │ ├── GettingStarted.md
│ │ ├── APIReference.md
│ │ ├── CitationSystem.md
│ │ └── Examples.md
│ ├── devs/ # Developer documentation
│ │ ├── architecture/
│ │ │ └── Overview.md
│ │ └── contribution_guidelines/
│ │ └── Contributing.md
│ └── appendices/ # Reference materials
│ └── glossary.md
└── table_of_contents.md # This file
- Prerequisites: Clearly stated at the beginning of each article
- Code examples: Always tested and functional
- Cross-references: Links to related documentation sections
- Audience indicators: User vs. developer content clearly marked
- Initial documentation release - Complete user and developer documentation suite
- Citation system guide - Comprehensive guide to scientific attribution features
- Architecture overview - Technical documentation for contributors
Found an issue with the documentation? Have suggestions for improvement?
- Errors or unclear content: Open an issue
- Contributing documentation: See Contributing Guide
This documentation follows the Cracking Shells organization documentation standards.