Dnd MCP

🚀 D&D Knowledge Navigator

A Python-based server implementing the Model Context Protocol (MCP) to connect AI assistants like Claude with Dungeons & Dragons 5th Edition (D&D 5e) game information.

🚀 Quick Start

The D&D Knowledge Navigator is a Python-based server that connects AI assistants such as Claude to D&D 5e game information through the Model Context Protocol (MCP). Below are the steps to get started with this project.

✨ Features

1. Core Functionality
   • Provides an access interface to D&D 5e data.
   • Implements the MCP protocol to support communication with AI assistants like Claude.
2. Attribution System
   • Records and manages data source information.
   • Supports custom source identifiers and reference information.
3. Query Enhancement System
   • Handles complex query requests.
   • Offers synonym support and fuzzy matching capabilities.
4. Template System
   • Generates aesthetically pleasing response outputs.
   • Supports custom templates to meet different requirements.

📦 Installation

Development Installation

# Clone the repository
git clone https://github.com/yourusername/dnd-knowledge-navigator.git
cd dnd-knowledge-navigator

# Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install the package in development mode
pip install -e .

Setup

Install Dependencies

Install the project and its dependencies using the following command:

pip install -r requirements.txt

Configure the Server

1. Create a Configuration File Create a config.json file in the project root directory and add the following content:

   {
     "api_key": "your_api_key_here",
     "debug_mode": true,
     "port": 5000
   }
   

2. Set Environment Variables Ensure the following environment variables are set:
   • DND_API_KEY: The key required to access the D&D API.
   • DEBUG_MODE: Enable debug mode (optional).

Start the Server

python dnd_mcp_server.py --config config.json

💻 Usage Examples

Run the Server

python dnd_mcp_server.py

Run Tests

./run_tests.py

📚 Documentation

The project provides detailed documentation covering the package structure, installation guide, running instructions, and contribution process. For a more in - depth understanding, please refer to the contents in the docs directory.

🔧 Technical Details

What is MCP?

The Model Context Protocol (MCP) is a framework developed by Anthropic that enables AI assistants like Claude to communicate with external tools and services. This server utilizes FastMCP (a Python implementation of Anthropic's tools) to connect these capabilities to D&D 5e data.

Project Structure

The D&D Knowledge Navigator, as a Python package, has the following structure:

dnd-knowledge-navigator/
├── dnd_mcp_server.py      # Main server entry point
├── run_tests.py           # Script to run all tests
├── setup.py               # Installation configuration file
├── src/                   # Source code directory
│   ├── __init__.py        # Package initialization
│   ├── attribution/       # Attribution system
│   ├── core/              # Core functionality
│   ├── query_enhancement/ # Query enhancement system
│   └── templates/         # Response formatting templates
├── tests/                 # Test directory
│   ├── __init__.py        # Test package initialization
│   └── test_*.py          # Test files
└── docs/                  # Documentation

🤝 Contribution

Contributions are welcome! Please feel free to submit pull requests.

1. Step-by-step Guide
   • Fork the repository.
   • Create a feature branch (git checkout -b feature/amazing-feature).
   • Commit your changes (git commit -m 'Add some amazing feature').
   • Push to the branch (git push origin feature/amazing-feature).
   • Open a pull request.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

🙏 Acknowledgments

• D&D 5e API for providing D&D data.
• Anthropic for developing the Model Context Protocol.
• FastMCP for providing the Python implementation of MCP.