使用说明

项目简介

PeakMojo Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM 应用提供访问 PeakMojo API 功能的桥梁。通过 इस 服务器，LLM 客户端可以使用标准化的 MCP 协议，安全、便捷地获取 PeakMojo 平台的资源和调用其提供的工具，从而实现更强大的应用场景。

主要功能点

资源访问: 提供了对 PeakMojo API 中多种资源的访问能力，包括用户 (Users)、人物角色 (Personas)、场景 (Scenarios) 等，允许 LLM 获取这些资源的数据。
工具调用: 将 PeakMojo API 的功能封装成可调用的工具，例如获取用户信息、搜索人物角色、创建场景等，使 LLM 能够执行特定的 PeakMojo 操作。
API 接口集成: 深度集成了 PeakMojo API，通过简单的配置即可连接到 PeakMojo 服务。
开发期 Mock 支持: 在开发阶段，即使无法连接到 PeakMojo API，服务器也能自动回退到模拟响应，方便开发和测试。
Docker 部署: 支持使用 Docker 部署，方便快捷地在各种环境中运行。
详细的错误处理: 具备完善的错误处理机制，能够记录错误日志，并以 JSON 格式返回错误信息。

安装步骤

确保已安装 Python 和 pip。

打开终端，运行以下命令安装 'mcp-server-peakmojo' 包：

pip install mcp-server-peakmojo

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能连接到 PeakMojo Server。以下是两种常用的配置方式，分别是直接运行 Python 源码和使用 Docker 镜像。

1. Python 源码运行配置

假设您已将项目代码下载到本地。

MCP 客户端配置 (JSON 格式):

{
  "mcpServers": {
    "peakmojo": {
      "command": "python",
      "args": [
        "-m",
        "mcp_server_peakmojo",
        "--api-key", "YOUR_PEAKMOJO_API_KEY",  // 替换为您的 PeakMojo API 密钥
        "--base-url", "https://api.staging.readymojo.com" // 可选: PeakMojo API 基础 URL，默认为 https://api.staging.readymojo.com
      ]
    }
  }
}

参数注释：

'command': 运行 MCP 服务器的命令，这里是 'python'。
'args': 传递给 'python' 命令的参数列表。
- '"-m", "mcp_server_peakmojo"': 以模块方式运行 'mcp_server_peakmojo'。
- '"--api-key", "YOUR_PEAKMOJO_API_KEY"': 必须配置，您的 PeakMojo API 密钥，用于身份验证。请替换 '"YOUR_PEAKMOJO_API_KEY"' 为您的实际密钥。
- '"--base-url", "https://api.staging.readymojo.com"': 可选配置，PeakMojo API 的基础 URL。如果您的 PeakMojo 服务部署在非默认地址，请修改此参数。

2. Docker 镜像运行配置

确保已安装 Docker。