Welcome to Thoth’s Documentation!

Thoth is a modern Python library providing advanced utilities and tools for developers, including a powerful Model Context Protocol (MCP) server framework.

Named after the ancient Egyptian god of wisdom and writing, Thoth aims to bring clarity and structure to your Python projects through well-designed, modular utilities.

User Guide:

• Getting Started
  • Installation
  • Quick Start
  • Next Steps

MCP Server:

• MCP Server Overview
  • Architecture
  • Core Components
  • Available Tools
  • Running the Server
  • Extending the Server
  • Testing
  • Further Reading
• Thoth MCP Tools Documentation
  • Available Tools
  • Testing Tools Locally
  • Adding New Tools

Development:

• Thoth Architecture
  • Overview
  • Project Structure
  • Design Principles
  • Module Organization
  • Extension Points
  • Dependencies Management
  • Configuration
  • Future Considerations
• Development Guide
  • Table of Contents
  • Development Setup
  • Development Workflow
  • Code Standards
  • Testing
  • Documentation
  • Release Process
  • Troubleshooting
• MCP Server Test Coverage
  • Test Suites Overview
  • Test Classes
  • Test Statistics
  • Key Testing Features
  • Running Tests
  • Adding New Tool Tests
  • Adding New Resource Tests
  • Best Practices
  • Future Enhancements
• Test Coverage
  • Coverage Summary
  • Coverage by Module
  • Running Coverage Locally
  • Coverage Configuration
  • CI/CD Integration
  • Coverage Goals
  • Interpreting the Report

API Reference:

• Modules Overview
  • thoth
    • thoth.ingestion
    • thoth.mcp_server
    • thoth.utils
  • thoth.ingestion
    • Chunk
    • ChunkMetadata
    • HandbookRepoManager
    • MarkdownChunker
    • thoth.ingestion.chunker
    • thoth.ingestion.repo_manager
  • thoth.mcp_server
    • ThothMCPServer
    • invoker()
    • run_server()
    • thoth.mcp_server.server
  • thoth.utils
    • thoth.utils.logger
  • Main Package
• Thoth Package
  • Subpackages
    • Ingestion Module
    • MCP Server Module
    • Utils Module
• Ingestion Module
  • Overview
    • Key Features
    • Example Usage
  • Module Contents
    • Repository Manager
    • Package Contents
• MCP Server Module
  • Server Module
    • ThothMCPServer
    • invoker()
    • run_server()
  • Classes
    • ThothMCPServer
  • Functions
    • invoker()
    • run_server()
  • Package Contents
    • ThothMCPServer
    • invoker()
    • run_server()
• Utils Module
  • Logger Utility
    • SensitiveDataFormatter
    • setup_logger()
    • SecureLogger
  • Package Contents

Indices and tables

• Index

• Module Index

• Search Page