Markdown 使用说明

  1. 项目简介
  • Sugar MCP Server 是一个实现 MCP(Model Context Protocol)通信的服务器组件,采用 Node.js 编写,使用标准输入输出(STDIN/STDOUT)进行 JSON-RPC 交互。
  • 服务器通过 Sugar 的命令行工具(Sugar CLI)实现实际功能调用,提供诸如创建任务、列出任务、查看任务、更新任务以及获取状态等能力的后端支持。
  1. 主要功能点
  • MCP 兼容通信:监听来自客户端的 JSON-RPC 请求,返回标准的 JSON-RPC 响应。
  • 与 Sugar CLI 集成:通过执行 sugar 命令来完成实际任务的创建、查询与更新等操作。
  • 自动初始化与探测:在启动时尝试检测 Sugar CLI 的可用性,并告知客户端当前运行状态。
  • STDIO 传输:默认通过标准输入输出进行通信,符合 MCP 服务器对多传输通道之一的实现模式(后续可扩展到 SSE/WebSocket)。
  1. 安装与运行
  • 运行方式(直接执行):
    • 给脚本可执行权限并直接运行:./sugar-mcp.js(需要系统支持 Node.js 的执行环境)
    • 或者通过 Node 运行:node sugar-mcp.js
  • 运行依赖:
    • Node.js 环境
    • Sugar CLI 已安装并可在系统路径中访问(通过 sugar --version 能正常返回版本信息)
  • 运行步骤简述:
    • 启动服务器:在合适的工作目录执行上述命令
    • 服务器启动后,等待客户端通过 STDIN 发送 MCP JSON-RPC 请求
    • 客户端接受服务器返回的 JSON-RPC 响应并继续后续交互
  1. 服务器配置(JSON 配置示例,客户端无需直接读取此配置,只用于 MCP 客户端在部署阶段了解服务器启动信息) { "serverName": "SugarMCPServer", "command": "node", "args": ["sugar-mcp.js"], "transport": "stdio", "description": "MCP 服务器,使用 Sugar CLI 作为后端实现的任务管理与状态查询能力", "notes": "该配置用于 MCP 客户端在启动阶段展示服务器信息。MCP 客户端无需在代码中嵌入该配置;仅用于文档化。" } 注释:
  • serverName: 此服务器在 MCP 客户端中的标识名称。
  • command: 启动服务器时使用的命令(此处使用 Node 运行 sugar-mcp.js)。
  • args: 启动参数列表。
  • transport: 传输协议,这里为 STDIO(标准输入输出)。
  • description/notes: 便于客户端理解服务器定位与能力范围。
  1. 基本使用方法
  • 客户端接入方式
    • 客户端通过将请求写入服务器的标准输入,并从标准输出读取响应来进行通信。
    • 请求与响应格式遵循 JSON-RPC 2.0,包含 fields such as jsonrpc, method, params, id;服务器返回包含 result 或 error,以及对应的 id。
  • 常用能力(示例性描述)
    • createTask: 在 Sugar 环境中创建一个新的任务
    • listTasks: 列出当前可用的任务
    • viewTask: 查看某个任务的详细信息
    • updateTask: 更新指定任务的属性
    • removeTask: 删除指定任务
    • getStatus: 获取服务器当前状态信息
  • 客户端与服务器的简单交互流程
    • 客户端向服务器发送一个 JSON-RPC 请求,例如创建一个新任务
    • 服务器执行 Sugar CLI 操作并将结果封装在 JSON-RPC 的响应中返回给客户端
    • 客户端解析响应并进行后续操作
  1. 关键词 Node.js, JSON-RPC, STDIO, Sugar CLI, 任务管理

  2. 分类 1

信息

分类

开发者工具