File size: 1,865 Bytes
1f2d50a |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# API Reference
Complete API documentation for KGraph-MCP.
## Overview
KGraph-MCP provides a comprehensive API for managing knowledge graphs, executing MCP tools, and orchestrating AI agents.
## API Sections
### [FastAPI Framework](api/index.md)
Core FastAPI application structure and endpoints for the KGraph-MCP platform.
### [Agent Framework](agents/index.md)
AI agents for planning and task execution with MCP tools.
### [Knowledge Graph Services](kg-services/index.md)
Core knowledge graph functionality and semantic services.
## Getting Started
1. **[Installation](../user-guide/installation.md)** - Set up the development environment
2. **[Quick Start](../user-guide/quick-start.md)** - Basic usage examples
3. **[Configuration](../user-guide/configuration.md)** - Configure the API
## Authentication
The API uses standard HTTP authentication methods. See the [Security Model](../architecture/security.md) for details.
## Rate Limiting
API endpoints are rate-limited to ensure fair usage. Current limits:
- 100 requests per minute for authenticated users
- 20 requests per minute for anonymous users
## Support
For API support and questions:
- GitHub Issues: [kgraph-mcp-hackathon](https://github.com/BasalGanglia/kgraph-mcp-hackathon/issues)
- Documentation: [Developer Guide](../developer-guide/index.md)
## Documentation Generation
This API documentation is automatically generated using:
- **Sphinx**: For autodoc extraction and processing
- **mkdocstrings**: For Markdown integration with MkDocs
- **Material for MkDocs**: For beautiful presentation
## Navigation
Use the navigation panel to browse through different modules and their components.
Each module page provides:
- Overview and description
- Class and function documentation
- Type hints and parameter information
- Source code links
- Usage examples (where available)
|