MCP Neo4j Knowledge Graph

🚀 MCP知識圖譜項目文檔

本項目旨在利用Neo4j圖數據庫構建和管理醫學領域的知識圖譜，提供了數據導入、實體操作等豐富功能模塊，助力醫學知識的高效管理與應用。

🚀 快速開始

啟動服務

運行命令 task run 啟動MCP服務。

運行測試

• 運行所有測試（包括pytest和集成測試）：task test
• 運行MCP客戶端測試：task test-client
• 運行MCP配置測試：task test-config
• 運行Neo4j連接測試：task test-db
• 運行集成測試：task test-integration

開發環境命令

• 格式化代碼：task format
• 運行代碼檢查：task lint
• 啟動開發環境：task dev

✨ 主要特性

核心組件

1. MCP客戶端：用於與Neo4j數據庫進行交互。
2. 配置工具：負責配置文件的加載和驗證。
3. Neo4j連接測試：確保數據庫 connectivity 和基本查詢功能。
4. 集成測試：驗證整個系統的完整性和兼容性。

📦 安裝指南

暫未提及安裝相關內容，可根據項目依賴和環境需求，藉助Poetry等工具安裝所需依賴。

💻 使用示例

基礎用法

啟動服務器

task run

獲取可用工具信息

# 通過訪問 /tools 接口獲取可用工具信息
curl /tools

獲取數據庫schema詳情

# 調用 /schema 接口獲取數據庫 schema 詳情，包括節點標籤、關係類型及其屬性
curl /schema

高級用法

運行客戶端測試

task test-client

運行配置測試

task test-config

運行數據庫測試

task test-db

📚 詳細文檔

功能模塊

1. MCP客戶端功能

• 啟動服務器：運行命令 task run 啟動MCP服務。
• 工具列表：通過訪問 /tools 接口獲取可用工具信息。
• 模式洞察：調用 /schema 接口獲取數據庫 schema 詳情，包括節點標籤、關係類型及其屬性。

2. MCP配置管理

• 配置文件加載：驗證 config.yaml 文件的正確性。
• 連接測試：使用官方MCP SDK測試與數據庫的連接狀態。
• 工具可用性檢查：確保所有必需工具均已安裝到位。

3. Neo4j數據庫連接

• 連通性驗證：通過基礎查詢測試數據庫是否可達。
• 環境配置：檢查和確認運行環境設置符合要求。

測試框架

測試腳本分類

1. mcp_neo4j_knowledge_graph/test_mcp_client.py：
   • 驗證服務器啟動狀態
   • 測試工具列表接口
   • 模式洞察功能驗證
   • 實體創建操作測試

   task test-client  # 僅運行客戶端測試
   

2. mcp_neo4j_knowledge_graph/test_mcp_config.py：
   • 測試配置文件加載邏輯
   • 驗證MCP SDK連接狀態
   • 確保所有工具可用

   task test-config  # 僅運行配置測試
   

3. mcp_neo4j_knowledge_graph/test_neo4j_connection.py：
   • 測試數據庫連通性
   • 驗證基本查詢功能
   • 確認環境配置無誤

   task test-db  # 僅運行數據庫測試
   

開發環境

使用Task命令

項目提供了多個開發任務命令：

# 格式化代碼
task format
# 運行代碼檢查
task lint
# 執行測試
task test
# 啟動開發環境
task dev

直接運行工具

藉助Poetry管理的開發工具包括：

• black：代碼格式化
• isort：導入排序
• flake8：代碼檢查
• pytest：單元測試 使用方法如下：

# 格式化代碼
poetry run black .
# 排序導入
poetry run isort .
# 運行代碼檢查
poetry run flake8
# 執行測試
poetry run pytest

錯誤處理

服務器實現了全面的錯誤處理機制，涵蓋以下場景：

• 數據庫連接問題
• 無效查詢
• 節點缺失
• 請求格式錯誤
• 模式驗證失敗
• 關係創建異常
• 實體更新衝突 所有錯誤均返回符合MCP協議的錯誤信息。

Docker配置

Neo4j容器配置如下：

• 端口：7474（HTTP）和 7687（Bolt）
• 默認憑據：neo4j/password
• APOC插件啟用
• 文件導入導出允許
• 健康檢查配置 可在 docker-compose.yml 文件中修改這些設置。

Task命令參考

# 啟動服務
task run
# 執行測試
task test
# 格式化代碼
task format
# 運行檢查
task lint
# 啟動開發環境
task dev