使用说明(Markdown)
-
项目简介
- 该仓库实现了一个 MCP 服务器,用于通过 JSON-RPC 风格的 MCP 协议向客户端暴露资源、工具和 Prompts,以供 LLM 客户端(如 Claude Desktop)调用和获取上下文信息,提供安全、可扩展的后端上下文服务。
-
主要功能点
- MCP 服务器核心:实现 MCP 服务器入口,注册并暴露多种工具(Tools),支持资源读取、消息发送、读取消息、发送和回复等功能。
- 资源与存储:提供本地和 Supabase 双模式存储,支持消息、密钥、已读/归档等状态管理。
- 加密能力:内置端对端加密支持,密钥对生成、导入、共享、加解密逻辑。
- License/Pro 功能:对 MCP Pro 功能进行 license 验证,作为受保护特性使用。
- 客户端集成:与 Claude Desktop 等 MCP 客户端对接,支持通过 stdio 传输实现通信。
- 附带的前端与工具链:包含本地 CLI、桌面应用与 VSCode 扩展等相关模块,示例性实现 MCP 客户端和辅助工具。
-
安装步骤
- 安装 Node.js 运行环境
- 在仓库根目录运行安装与构建(示例命令,可按实际项目脚本执行)
- npm install
- npm run build
- 启动 MCP 服务器(示例命令,实际路径可能随实现调整)
- node dist/server.js
- 如需 Claude Desktop 等客户端接入,请参考客户端的 MCP 配置,将服务器作为一个 MCP 服务接入。
-
服务器配置(MCP 客户端需要的最小信息) 该配置用于 MCP 客户端在连接 MCP 服务器时指定服务器名称、启动命令及参数等信息(JSON 格式,非代码块,便于直接粘贴使用),示例仅作参考,实际路径/环境请按实际部署填写。 { "server_name": "myceliumail", "command": "node", "args": ["/path/to/mcp-server/dist/server.js"], "env": { "MYCELIUMAIL_AGENT_ID": "claude-desktop", "SUPABASE_URL": "https://your-project.supabase.co", "SUPABASE_ANON_KEY": "your-anon-key" } } 注释说明:
- server_name: MCP 服务器在客户端注册时的唯一标识名称,需与服务端一致以便客户端正确连接。
- command: 启动 MCP 服务器所用的命令(如 node、python 等)。
- args: 服务器启动所需的参数列表,通常包括服务器入口文件路径。
- env: 环境变量配置,需包含代理身份、云存储连接信息等,确保服务器可访问所需资源。
-
基本使用方法
- 启动服务器后,客户端(如 Claude Desktop)配置 MCP 服务器信息以建立连接。
- 客户端连接成功后即可通过 MCP 的 Tools 接口调用服务器暴露的工具、访问资源,以及获取 Prompts。
- server 的多工具支持允许 LLM 在对话中读取 mailbox、发送消息、读取特定消息、归档等操作。
信息
分类
开发者工具