🚀 TG_MCP
TG_MCP是一个轻量级的Python接口，它将TigerGraph操作（如查询、模式、顶点、边、UDF）作为结构化工具和基于URI的资源暴露给MCP代理，为TigerGraph操作提供了便捷的访问方式。
🚀 快速开始
TG_MCP是一个轻量级的Python接口，可将TigerGraph操作作为结构化工具和基于URI的资源暴露给MCP代理。以下是使用该项目的基本步骤：
- 克隆仓库：
git clone [仓库地址]
cd TG_MCP
- 创建和激活虚拟环境（推荐）：
python -m venv env
source env/bin/activate # 在Windows上使用`env\Scripts\activate`
- 安装依赖项：
pip install -r requirements.txt
- 设置环境变量：
export TG_HOST="http://localhost:14200"
export TG_GRAPH="my_graph"
export TG_SECRET="your_api_secret_key"
- 连接到Claude Desktop：
python -m tg_mcp.main install
在Claude Desktop中重启客户端以应用更改。
✨ 主要特性
- 模式introspection：可获取完整的图模式（顶点和边类型）。
- 查询执行：能够运行已安装的GSQL查询或带有参数的原始GSQL字符串。
- 顶点和边的插入/更新：支持创建或更新顶点和边。
- 资源URI：可通过
tgraph://vertex/...和tgraph://query/...URI访问图对象。 - UDF及算法列表：可以获取已安装的用户定义函数和GDS算法目录。
📦 安装指南
- 克隆仓库：
git clone [仓库地址]
cd TG_MCP
- 创建和激活虚拟环境（推荐）：
python -m venv env
source env/bin/activate # 在Windows上使用`env\Scripts\activate`
- 安装依赖项：
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：
- 安装完成后，运行以下命令：
python -m tg_mcp.main install
- 在Claude Desktop中重启客户端以应用更改。
贡献
要为项目做贡献，请按照以下步骤操作：
- Fork此仓库。
- 创建功能分支：
git checkout -b feature/your-feature-name - 提交更改：
git add . && git commit -m "你的提交信息" - 推送到远程仓库：
git push origin feature/your-feature-name - 提交拉取请求。
💻 使用示例
基础用法
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文件以获取详细信息。