Zuraffa MCP 服务器
使用说明(Markdown格式)
-
项目简介 Zuraffa 提供了一个用于将资源、工具和提示模板集中管理并通过 MCP 协议与 AI 客户端对接的服务器实现。该 MCP 服务器核心职责是:托管和管理资源数据、注册并执行工具、定义和渲染 Prompt 模板,并通过 JSON-RPC 与客户端通信,支持会话管理与能力声明,以及多传输协议的接入。
-
主要功能点
- 支持 MCP 协议的 JSON-RPC 请求与响应,确保与 AI 客户端(如 Claude Desktop、Cursor、VS Code 等)对接的标准化通信
- 资源(Resources)托管与访问,提供数据能力
- 工具(Tools)注册与执行,允许远程/外部功能调用
- Prompt 模板的定义、管理与渲染,支持灵活的对话上下文
- 会话管理与能力声明,确保多轮对话中的上下文一致性
- 多传输协议支持,提供 STDIO、Server-Sent Events(SSE)、WebSocket 等传输方式
- 安全、可扩展的后端架构,方便与前端/LLM 客户端集成
- 提供从源码编译和/或下载可执行二进制的部署方式,便于快速落地
-
安装步骤
- 全局安装方式(推荐): 通过 Dart 的全局包管理器安装 Zuraffa,然后使用其中的 MCP 服务端工具来启动服务器
- 二进制方式(快速启动): 直接从 GitHub Releases 下载预编译的 MCP 服务器二进制,解压后直接执行
- 从源码编译方式(定制化部署): 使用 Dart 编译命令将源码编译为可执行文件,如 bin/zuraffa_mcp_server.dart 生成的可执行程序
-
服务器配置(JSON 配置示例,供 MCP 客户端参考) 请以如下 JSON 形式配置 MCP 服务器(字段含义说明在括号中): { "server_name": "Zuraffa MCP Server", // 服务器名称,供客户端展示 "command": "zuraffa_mcp_server", // 启动服务的命令/可执行文件名 "args": [ // 启动参数,按照实际部署传输协议与端口等配置 "--host=0.0.0.0", "--port=9123", "--transport=websocket", "--log-level=info" ], "description": "MCP 服务端,提供资源、工具与提示模板的上下文服务" }
说明:
- server_name 是对外显示的名称,便于在客户端清晰识别
- command 是启动 MCP 服务器时使用的可执行文件名,需与实际部署路径一致
- args 是启动参数集合,建议包含主机、端口、传输协议等配置,便于客户端建立连接
- 该配置仅用于 MCP 客户端的连接信息展示;实际运行仍依赖于部署环境中的文件路径与系统权限
-
基本使用方法
- 启动服务器 在服务器环境中执行可执行的 MCP 服务器程序(如 zuraffa_mcp_server),可传入上面的参数进行监听
- 客户端连接 MCP 客户端通过配置的服务器地址、端口与传输协议连接并发送 JSON-RPC 请求,例如读取资源、调用工具、获取 Prompt 等
- 运行与监控 观察服务器输出日志,确认与客户端的请求/响应流程正常;如遇到连接问题,检查防火墙/端口、网络权限及传输协议配置
- 关闭与维护 在需要维护或升级时,优雅关闭服务器并进行必要的热重载/重启流程
-
额外信息
- MCP 服务器可与多种前端/IDE 集成,方便在本地或云端进行 AI 辅助编码与上下文管理
- 如需自定义资源、工具、Prompts 的注册与渲染逻辑,可直接修改服务器实现或通过配置扩展以满足特定需求