使用说明
项目简介
eRegulations MCP服务器是一个实现了Model Context Protocol (MCP) 的后端应用,旨在为大型语言模型(LLM)提供访问和操作eRegulations数据的标准化接口。该服务器充当LLM客户端与eRegulations API之间的桥梁,使得AI模型能够更方便、更有效地理解和利用法规信息。
主要功能点
- 标准化数据访问: 通过MCP协议,以结构化的方式向LLM客户端提供eRegulations数据,包括程序、步骤、要求和费用等信息。
- 工具集成: 提供预定义的工具(Tools),如 'listProcedures', 'getProcedureDetails', 'getProcedureStep',允许LLM客户端调用这些工具来查询和检索特定的法规数据。
- Prompt模板: 内置MCP Prompt模板,指导LLM客户端如何正确使用工具,优化LLM与服务器的交互,提高任务完成的准确性和效率。
- 多种传输协议支持: 支持标准I/O和HTTP (SSE) 两种传输协议,适应不同的LLM客户端和应用场景。
- 易于部署: 提供Docker Compose部署方式,方便用户快速搭建和运行服务器。
安装步骤
-
克隆仓库
git clone https://github.com/unctad-ai/eregulations-mcp-server.git cd eregulations-mcp-server -
安装依赖
npm install -
构建项目
npm run build
服务器配置
MCP客户端需要配置以下信息以连接到eRegulations MCP服务器。以下是JSON格式的配置信息示例,包含了服务器的启动命令 (command) 及其参数 (args)。
标准 I/O 模式 (推荐)
{ "serverName": "eRegulations MCP Server (Stdio)", "command": "node", "args": [ "dist/index.js" ], "environmentVariables": { "EREGULATIONS_API_URL": "<your_eregulations_api_url>" } }
参数注释:
- 'serverName': 自定义的服务器名称,用于在MCP客户端中标识。
- 'command': 启动服务器的可执行命令,这里使用 'node'。
- 'args': 传递给 'node' 命令的参数,'dist/index.js' 是编译后的服务器入口文件。
- 'environmentVariables': 环境变量配置,务必将 '<your_eregulations_api_url>' 替换为实际的eRegulations API URL。
HTTP Server 模式 (SSE)
{ "serverName": "eRegulations MCP Server (SSE)", "command": "node", "args": [ "dist/sse.js" ], "environmentVariables": { "EREGULATIONS_API_URL": "<your_eregulations_api_url>", "PORT": "7000" } }
参数注释:
- 'serverName': 自定义的服务器名称,用于在MCP客户端中标识。
- 'command': 启动服务器的可执行命令,这里使用 'node'。
- 'args': 传递给 'node' 命令的参数,'dist/sse.js' 是SSE传输模式的服务器入口文件。
- 'environmentVariables': 环境变量配置,务必将 '<your_eregulations_api_url>' 替换为实际的eRegulations API URL,'PORT' 指定HTTP服务器端口,默认为 '7000'。
Docker Compose 部署
如果使用Docker Compose部署,请确保已安装Docker和Docker Compose。
-
修改 'docker-compose.yml' 文件中的 'EREGULATIONS_API_URL' 环境变量为实际的eRegulations API URL。
-
启动服务:
docker-compose up -d
基本使用方法
- 启动服务器: 根据选择的模式(标准 I/O 或 HTTP Server),运行相应的启动命令(例如 'node dist/index.js' 或 'node dist/sse.js')或使用 Docker Compose 启动。
- 配置MCP客户端: 在您的MCP客户端应用中,根据上述提供的服务器配置信息,配置连接到eRegulations MCP服务器。
- 使用工具和Prompt: 通过MCP客户端,您可以调用服务器提供的工具(如 'listProcedures','getProcedureDetails','getProcedureStep')来查询eRegulations数据。利用Prompt模板可以指导LLM更有效地与服务器交互。
- 查看日志: 服务器运行日志会输出在控制台,可以用于监控服务器运行状态和调试问题。
信息
分类
网页与API