使用说明(Markdown 版本)
-
项目简介
- 这是一个基于 MCP 架构的后端服务器实现,结合了 CRM 功能与 MCP 服务能力,能够向 LLM 客户端提供资源访问、工具执行、提示模板等能力,并通过 JSON-RPC 进行通信。当前服务器以 STDIO 传输实现并具备与 Claude Desktop 的集成能力,未来可扩展为 SSE/WebSocket 等传输方式。
-
主要功能点
- MCP 核心能力:托管资源(Resources)、注册与执行 Tools、定义与渲染 Prompts,向 LLM 客户端提供标准化上下文服务。
- JSON-RPC 通信:客户端通过标准的 MCP 请求/响应格式进行调用,服务器按请求返回 JSON-RPC 响应。
- 多组件集成:通过 CLA 指令入口启动 MCP 服务器,并与 Charm KV 作为后端数据源进行交互,支持 CRM 的创建、查询、更新等操作的工具化封装。
- 服务器与命令路由:主程序能够根据命令行参数路由到 MCP 服务、CRM CLI、Web UI、TUI 等不同模块,提供清晰的开发与运维入口。
- 可扩展性:当前实现提供了基于 Go 的模块化处理(工具、资源、提示、Viz、Followups 等),后续可增加更多工具、资源类型和传输通道。
-
安装步骤
- 需要在具备 Go 环境的开发/运行环境中编译运行本仓库。
-
- 克隆仓库并进入项目目录。
-
- 运行 go build 生成可执行程序,例如构建主程序包含 MCP 服务的二进制。
-
- 直接执行可执行文件并传入相应子命令,例如启动 MCP 服务:./pagen mcp
-
- Claude Desktop 等 MCP 客户端按官方文档配置本服务器的启动命令与参数(见下方服务器配置示例),以通过 JSON-RPC 进行通信。
-
服务器配置(MCP 客户端连接信息示例) 说明:MCP 客户端需要一个 JSON 配置来指明服务器的名字、启动命令和参数。下列配置仅用于示意,请在实际环境中替换为你的部署路径与参数。 { "server": "pagen", "command": "/path/to/pagen", "args": ["mcp"] } 注解:
- server: MCP 服务器的唯一名称,在 Claude Desktop 等客户端配置中使用。
- command: 启动 MCP 服务器的可执行文件路径。
- args: 启动时传递给服务器的参数数组,此处规定为 ["mcp"],用于启动 MCP 服务器模块。
-
基本使用方法
- 启动 MCP 服务器:运行可执行程序并传入 mcp 子命令,确保 Claude Desktop 已在配置中指向该命令与参数。
- 使用 CRM CLI/WEB/TUI 等其他功能时,客户端将通过 MCP 服务器请求对应的资源、工具、Prompts 等以实现对 CRM 的上下文能力调用。
- 如需在 Claude Desktop 中使用 CRM 的 22 种工具,请确保工具、资源和提示在 MCP 服务器端正确注册并暴露给客户端。
-
其他注意事项
- 服务器端当前实现基础上支持至少 STDIO 传输,未来可扩展以支持 SSE、WebSocket 等传输协议。
- 服务器对会话管理、能力声明、以及安全性有基本框架,具体的访问控制及权限策略可在后续扩展中进一步完善。
信息
分类
商业系统