使用说明
项目简介
本项目是一个MCP(Model Context Protocol)服务器的实现,旨在连接AI助手和Beckn协议网络。它允许AI系统通过标准化的MCP协议,访问和操作Beckn网络中的各种服务,例如出行、零售和餐饮等。该服务器充当AI助手与Beckn生态系统之间的桥梁,使得AI能够理解用户自然语言指令,并转化为对Beckn网络服务的具体操作。
主要功能点
- MCP 服务器: 接收来自AI助手的MCP协议请求,作为AI与Beckn网络交互的入口。
- 意图映射 (Intent Mapper): 将用户自然语言查询映射为结构化的Beckn意图,理解用户需求。
- Goose 编排器 (Goose Orchestrator): 使用Goose框架(此处为Mock实现)管理业务流程,协调不同工具完成Beckn操作。
- Beckn 客户端 (Beckn Client): 负责与Beckn网络进行协议通信,执行搜索、选择、初始化和确认等操作。
安装步骤
- 克隆仓库
git clone https://github.com/Mind-Inc/MCP-Beckn.git cd MCP-Beckn - 安装依赖
确保已安装Node.js (v18+) 和 npm。运行以下命令安装项目依赖:
npm install - 配置环境变量
复制 '.env.example' 文件为 '.env',并根据需要编辑 '.env' 文件进行配置。 示例 '.env.example' 文件可能包含端口配置等。
cp .env.example .env # 编辑 .env 文件 (可选) - 启动服务器
运行以下命令启动开发服务器:
服务器默认将在3000端口启动。npm run dev
服务器配置
以下是MCP客户端连接 Beckn MCP Bridge 服务器所需的配置信息(JSON格式)。MCP客户端需要配置服务器的启动命令和参数以建立连接。
{ "server name": "beckn-mcp-server", "command": "node", "args": ["src/index.ts"] }
- 'server name': 服务器的名称,可以自定义。
- 'command': 启动服务器的命令,这里使用 'node' 运行 Node.js 程序。
- 'args': 启动命令的参数,指定服务器入口文件为 'src/index.ts'。
基本使用方法
服务器启动后,MCP客户端可以向服务器的 '/mcp/v1' 端点发送POST请求,以JSON格式传递用户查询和上下文信息。
请求示例 (JSON):
{ "query": "帮我从MG路打车到机场", "context": { "user_id": "user123" } }
使用curl测试:
curl -X POST http://localhost:3000/mcp/v1 \ -H "Content-Type: application/json" \ -d '{"query": "Book me a cab from MG Road to the airport", "context": {"user_id": "user123"}}'
服务器将处理请求,调用Beckn网络服务,并将结果以JSON格式返回给MCP客户端。
信息
分类
商业系统