项目简介
'create-motoko-mcp-server' 是一个官方的命令行接口 (CLI) 工具,旨在帮助开发者快速启动一个新的、可用于生产环境的Motoko语言 MCP(Model Context Protocol)服务器。它为基于互联网计算机 (Internet Computer) 的去中心化应用提供了一个标准化的后端框架,用于管理资源、工具和Prompt模板,并与大型语言模型 (LLM) 客户端进行高效通信。该工具消除了从零开始配置项目的繁琐工作,让开发者能够专注于业务逻辑的实现。
主要功能点
- 快速项目生成: 轻松创建带有完整项目结构(包括 'dfx.json', 'mops.json', 'package.json')的Motoko MCP服务器。
- 预配置依赖: 自动集成Prometheus协议所需的ICRC标准(如 'ICRC-126', 'ICRC-127')和其他必要SDK。
- 内置开发脚本: 提供部署、测试、启动本地副本等常用npm脚本,简化开发流程。
- App Store集成: 内置App Store CLI工具,并提供发布到Prometheus App Store的便捷脚本。
- 可选认证功能: 预留API密钥和Prometheus OAuth的代码块,方便实现服务器的访问控制和货币化。
- 示例工具: 包含一个简单的"echo"工具,演示MCP服务器中工具的基本结构和调用方式。
安装步骤
- 安装Node.js: 确保安装了Node.js 18.0或更高版本。
- 安装DFX: 按照DFINITY官方指南安装DFINITY Canister SDK。
- 安装MOPS: 按照MOPS官方指南安装Motoko包管理器。
- 安装Git: 确保已安装Git版本控制系统。
- 创建新项目: 在终端中运行以下命令来生成一个新的MCP服务器项目(例如,项目名为 'my-awesome-app'):
npx create-motoko-mcp-server my-awesome-app - 安装项目依赖: 进入新创建的项目目录,并安装其依赖:
cd my-awesome-app npm install npm run mops:install
服务器配置
MCP客户端需要配置MCP服务器的启动命令和参数才能建立连接。以下是基于此工具生成的Motoko MCP服务器的典型配置信息示例,请根据实际部署环境和MCP客户端的要求进行调整:
{ "serverName": "MyMotokoMCP", "command": "dfx", "args": [ "canister", "call", "<YOUR_CANISTER_NAME>", "handle_json_rpc_request" ], "env": { // 可选:根据需要添加环境变量,例如: // "DFX_NETWORK": "ic" }, "description": "连接到部署在Internet Computer上的Motoko MCP服务器。需要替换<YOUR_CANISTER_NAME>为实际的Canister ID。" }
- 'serverName': 服务器的名称,可以自定义,用于MCP客户端识别。
- 'command': 启动MCP服务器进程的命令。对于Motoko MCP服务器,通常使用 'dfx' 命令来与部署在Internet Computer上的Canister进行交互。
- 'args': 'command' 命令的参数列表。
- '"canister"': 'dfx' 的子命令,表示操作Canister。
- '"call"': 'dfx canister' 的子命令,表示调用Canister的一个方法。
- '"<YOUR_CANISTER_NAME>"': 重要! 这里需要替换为你的Motoko MCP服务器部署后获得的实际Canister ID。
- '"handle_json_rpc_request"': 这是MCP服务器接收和处理JSON-RPC请求的方法名称。MCP客户端将通过调用此方法与服务器进行通信。
- 'env': 可选的环境变量配置,可以根据需要添加,例如指定DFX网络。
- 'description': 对此配置的简要说明,帮助用户理解其用途。
基本使用方法
- 启动本地副本: 在你新创建的项目目录中运行 'npm run start',这将启动一个本地的Internet Computer副本。
- 部署服务器: 运行 'npm run deploy' 命令,将你的Motoko Canister(即MCP服务器)部署到本地副本或指定的Internet Computer网络。
- 使用MCP Inspector测试: 部署成功后,运行 'npm run inspector' 将启动MCP Inspector工具,你可以用它来测试你的服务器功能,如调用示例中的"echo"工具。
- 集成MCP客户端: 使用上述“服务器配置”信息,将你的Motoko MCP服务器集成到任何兼容的MCP客户端中,从而使LLM应用能够调用服务器的功能和访问其管理的数据。
信息
分类
开发者工具