Puppygraph MCP Server

🚀 Graph MCP 服务器

Graph MCP 服务器为 PuppyGraph 提供模型上下文协议 (MCP) 服务，允许 Claude 通过 Claude Desktop，使用 Gremlin 和 Cypher 查询图数据库。

🚀 快速开始

在使用 Graph MCP 服务器之前，需要满足以下先决条件：

1. 确保目标服务器正在运行并可通过网络访问
2. 验证防火墙规则是否允许相应端口的通信
3. 确保提供的身份验证凭据正确无误

之后，按照以下步骤进行安装：

# 安装所有依赖项
npm install

# 启动开发服务器
npm start

# 构建生产环境版本
npm run build

✨ 主要特性

• 使用 Neo4j Bolt 协议（用于 Cypher）和 WebSocket（用于 Gremlin）连接到多个 PuppyGraph 实例
• 使用 Gremlin 和 Cypher 查询语言查询图数据
• 从多个端点获取图结构和模式信息
• 包含用于验证连接状态的工具

📦 安装指南

# 安装所有依赖项
npm install

# 启动开发服务器
npm start

# 构建生产环境版本
npm run build

💻 使用示例

项目结构

puppy-graph-mcp/
├── src/                 # 源代码目录
│   ├── main.ts         # 主程序入口
│   └── services/       # 外部服务接口实现
├── tests/              # 测试用例
└── package.json        # 项目依赖和脚本

配置说明

• 环境变量 | 属性 | 详情 | |------|------| | 变量名 | 描述 | | PUPPYGRAPH_WS_URL | Gremlin WebSocket 地址，默认值为 ws://localhost:8080 | | PUPPYGRAPH_NEO4J_URI | Neo4j 连接 URI，默认值为 bolt://localhost:7687 | | PUPPYGRAPH_SCHEMA_URL | Schema HTTP 端点，默认值为 http://localhost:3000/schema |

工具使用

基础用法

# 查询连接状态
puppygraph status

高级用法

# 执行 Cypher 查询
puppygraph query --cypher "MATCH (n) RETURN count(n)"

# 执行 Gremlin 查询
puppygraph gremlin g.V().count()

📚 详细文档

项目特点

• 模块化架构：代码按功能划分模块，便于维护和扩展
• 异步通信：使用 async/await 实现非阻塞操作
• 错误处理：提供详细的错误日志和重试机制
• 可扩展性：支持插件扩展以增加更多功能

项目状态

当前版本为 v1.0.0，已通过基础测试和验证。

📄 许可证

本项目采用 Apache 2.0 许可证。