Dnd MCP

🚀 D&D 知識導航器

D&D 知識導航器是一個基於 Python 的服務器項目，它藉助模型上下文協議（MCP），將 Claude 等人工智能助手與《龍與地下城》第 5 版（D&D 5e）的遊戲信息緊密連接，為玩家和開發者提供了便捷的遊戲數據訪問與交互方式。

🚀 快速開始

安裝

開發安裝

# 克隆倉庫
git clone https://github.com/yourusername/dnd-knowledge-navigator.git
cd dnd-knowledge-navigator

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # 在 Windows 上：.venv\Scripts\activate

# 以開發模式安裝包
pip install -e .

安裝依賴項

使用以下命令安裝項目及其依賴：

pip install -r requirements.txt

配置服務器

1. 創建配置文件
   在項目根目錄下創建 config.json 文件，並添加以下內容：

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

2. 設置環境變量
   確保以下環境變量已設置：

• DND_API_KEY：訪問 D&D API 所需的密鑰。
• DEBUG_MODE：啟用調試模式（可選）。

啟動服務器

python dnd_mcp_server.py --config config.json

運行測試

./run_tests.py

✨ 主要特性

1. 核心功能
   • 提供對 D&D 5e 數據的訪問接口，方便用戶獲取遊戲相關信息。
   • 實現 MCP 協議，支持與 Claude 等 AI 助手通信，拓展了項目的應用場景。
2. 來源歸屬系統
   • 記錄和管理數據來源信息，確保數據的可追溯性。
   • 支持自定義來源標識符和引用信息，滿足不同用戶的需求。
3. 查詢增強系統
   • 處理複雜的查詢請求，提升用戶查詢的準確性和效率。
   • 提供同義詞支持和模糊匹配功能，讓用戶更輕鬆地找到所需信息。
4. 模板系統
   • 生成美觀的響應輸出，提升用戶體驗。
   • 支持自定義模板以滿足不同需求，增加了項目的靈活性。

📦 安裝指南

開發安裝

# 克隆倉庫
git clone https://github.com/yourusername/dnd-knowledge-navigator.git
cd dnd-knowledge-navigator

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # 在 Windows 上：.venv\Scripts\activate

# 以開發模式安裝包
pip install -e .

設置

安裝依賴項

pip install -r requirements.txt

配置服務器

1. 創建配置文件
   在項目根目錄下創建 config.json 文件，並添加以下內容：

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

2. 設置環境變量
   確保以下環境變量已設置：

• DND_API_KEY：訪問 D&D API 所需的密鑰。
• DEBUG_MODE：啟用調試模式（可選）。

💻 使用示例

基礎用法

啟動服務器：

python dnd_mcp_server.py --config config.json

高級用法

運行測試：

./run_tests.py

📚 詳細文檔

項目提供了詳細的文檔，涵蓋包結構、安裝指南、運行說明以及貢獻流程。對於更深入的理解，請查閱 docs 目錄中的內容。

🔧 技術細節

MCP 是什麼？

模型上下文協議（MCP）是由 Anthropic 開發的一個框架，使人工智能助手如 Claude 能夠與外部工具和服務進行通信。此服務器利用了 FastMCP（Anthropic 工具的 Python 實現），以將這些功能連接到《龍與地下城》5版的數據。

項目結構

D&D 知識導航器作為一個 Python 包，具有以下結構：

dnd-knowledge-navigator/
├── dnd_mcp_server.py      # 主服務器入口點
├── run_tests.py           # 運行所有測試的腳本
├── setup.py               # 安裝配置文件
├── src/                   # 源代碼目錄
│   ├── __init__.py        # 包初始化
│   ├── attribution/       # 來源歸屬系統
│   ├── core/              # 核心功能
│   ├── query_enhancement/ # 查詢增強系統
│   └── templates/         # 響應格式化模板
├── tests/                 # 測試目錄
│   ├── __init__.py        # 測試包初始化
│   └── test_*.py          # 測試文件
└── docs/                  # 文檔

📄 許可證

此項目在 MIT 許可證下發行。請查看 LICENSE 文件以獲取詳細信息。

致謝

• D&D 5e API 提供了 D&D 數據
• Anthropic 開發了模型上下文協議
• FastMCP 提供了 Python 實現的 MCP

貢獻

歡迎貢獻！請隨意提交拉取請求。

1. 步驟指南
   • Fork 倉庫
   • 創建功能分支 (git checkout -b feature/amazing-feature)
   • 提交更改 (git commit -m 'Add some amazing feature')
   • 推送到分支 (git push origin feature/amazing-feature)
   • 打開拉取請求