Tigergraph

🚀 TG_MCP

TG_MCP是一個輕量級的Python接口，它將TigerGraph操作（如查詢、模式、頂點、邊、UDF）作為結構化工具和基於URI的資源暴露給MCP代理，為TigerGraph操作提供了便捷的訪問方式。

🚀 快速開始

TG_MCP是一個輕量級的Python接口，可將TigerGraph操作作為結構化工具和基於URI的資源暴露給MCP代理。以下是使用該項目的基本步驟：

1. 克隆倉庫：

git clone [倉庫地址]
cd TG_MCP

2. 創建和激活虛擬環境（推薦）：

python -m venv env
source env/bin/activate  # 在Windows上使用`env\Scripts\activate`

3. 安裝依賴項：

pip install -r requirements.txt

4. 設置環境變量：

export TG_HOST="http://localhost:14200"
export TG_GRAPH="my_graph"
export TG_SECRET="your_api_secret_key"

5. 連接到Claude Desktop：

python -m tg_mcp.main install

在Claude Desktop中重啟客戶端以應用更改。

✨ 主要特性

• 模式introspection：可獲取完整的圖模式（頂點和邊類型）。
• 查詢執行：能夠運行已安裝的GSQL查詢或帶有參數的原始GSQL字符串。
• 頂點和邊的插入/更新：支持創建或更新頂點和邊。
• 資源URI：可通過tgraph://vertex/...和tgraph://query/... URI訪問圖對象。
• UDF及算法列表：可以獲取已安裝的用戶定義函數和GDS算法目錄。

📦 安裝指南

1. 克隆倉庫：

git clone [倉庫地址]
cd TG_MCP

2. 創建和激活虛擬環境（推薦）：

python -m venv env
source env/bin/activate  # 在Windows上使用`env\Scripts\activate`

3. 安裝依賴項：

pip install -r requirements.txt

📚 詳細文檔

項目結構

TG_MCP/
├── config.py            # 環境配置（HOST, GRAPH, SECRET）
├── tg_client.py         # 封裝TigerGraphConnection和核心操作
├── tg_tools.py          # `@mcp.tool`定義，暴露客戶端方法
├── tg_resources.py      # `@mcp.resource` URI處理程序
├── README.md            # 項目說明文檔
└── requirements.txt     # 依賴項列表

配置

設置以下環境變量：

• TG_HOST: TigerGraph實例地址（例如，http://localhost:14200）
• TG_GRAPH: 要操作的圖名稱
• TG_SECRET: TigerGraph REST API訪問密鑰

示例：

export TG_HOST="http://localhost:14200"
export TG_GRAPH="my_graph"
export TG_SECRET="your_api_secret_key"

連接到Claude

要將此MCP服務器連接到Claude Desktop：

1. 安裝完成後，運行以下命令：

python -m tg_mcp.main install

2. 在Claude Desktop中重啟客戶端以應用更改。

貢獻

要為項目做貢獻，請按照以下步驟操作：

1. Fork此倉庫。
2. 創建功能分支：git checkout -b feature/your-feature-name
3. 提交更改：git add . && git commit -m "你的提交信息"
4. 推送到遠程倉庫：git push origin feature/your-feature-name
5. 提交拉取請求。

💻 使用示例

基礎用法

from tg_mcp import TGClient

client = TGClient()
# 獲取頂點和邊的模式定義
schema = client.get_schema()
print(schema)

高級用法

result = client.execute_query("MATCH (a) RETURN a LIMIT 1")
print(result)

📄 許可證

本項目受[許可證名稱]約束。請參閱LICENSE文件以獲取詳細信息。