使用说明

项目简介

EduBase MCP 服务器是 EduBase 教育平台 Model Context Protocol (MCP) 的服务器端实现。它允许 MCP 客户端 (例如 Claude Desktop) 和大型语言模型 (LLM) 通过标准化的 MCP 协议，安全访问和操作 EduBase 平台上的教育资源和功能。

主要功能点

资源 (Resources) 访问: 通过预定义的工具 (Tools)，LLM 客户端可以访问 EduBase 平台上的各类教育资源，例如题库中的题目、课程信息、用户数据等。
工具 (Tools) 执行: 将 EduBase 平台的 API 接口封装为 MCP 工具，LLM 客户端可以调用这些工具，实现例如创建题目、查询用户信息、管理课程等操作。
Prompt 模板 (Prompts): 虽然仓库信息中未明确提及 Prompt 模板，但作为 MCP 服务器，它为未来支持 Prompt 模板功能预留了空间，以便根据不同的 LLM 交互模式定制 Prompt。
标准化通信: 采用 JSON-RPC 协议与 MCP 客户端进行通信，确保了交互的标准化和跨平台兼容性。
会话管理和能力声明: 服务器端负责会话管理，并在连接时向客户端声明自身的能力 (Capabilities)，例如支持的工具列表。
多种传输协议支持: 当前实现基于 Stdio (标准输入/输出) 传输协议，为 MCP 客户端提供基本的连接方式。

安装步骤

前提条件: 确保你的环境中已安装 Node.js 和 npm (Node.js 包管理器)。

下载仓库: 使用 Git 克隆仓库到本地：

git clone https://github.com/EduBase/MCP
cd MCP

安装依赖: 在仓库根目录下，使用 npm 安装项目依赖：
```
npm install
```
构建项目: 运行构建脚本，将 TypeScript 代码编译为 JavaScript 代码 (如果你需要部署到生产环境，或者使用 'dist' 目录下的预构建版本则可以跳过此步骤)：
```
npm run build
```

服务器配置

MCP 服务器是为 MCP 客户端设计的，客户端需要配置服务器的启动命令和参数才能连接。以下是在 'claude_desktop_config.json' 中配置 EduBase MCP 服务器的示例，展示了如何配置 'command' 和 'args' 字段：

{
  "mcpServers": {
    "edubase": {
      "command": "node",
      "args": [
        "/path/to/MCP/dist/index.js" //  **[请替换为你的仓库实际路径]**：指向 'index.js' 文件，这是 EduBase MCP 服务器的入口文件。
      ],
      "env": {
        "EDUBASE_API_URL": "https://domain.edubase.net/api", //  **[请替换为你的 EduBase API URL]**：你的 EduBase 平台的 API 根地址。
        "EDUBASE_API_APP": "your_integration_app_id", //  **[请替换为你的 EduBase 集成应用 ID]**：你在 EduBase 平台创建的集成应用的 ID。
        "EDUBASE_API_KEY": "your_integration_secret_key"  //  **[请替换为你的 EduBase 集成应用密钥]**：与你的集成应用 ID 配对的密钥，用于 API 鉴权。
      }
    }
  }
}

配置参数说明:

'"command": "node"': 指定启动 MCP 服务器的命令为 'node'，表示使用 Node.js 运行时环境。
'"args": ["/path/to/MCP/dist/index.js"]': 'args' 数组包含传递给 'node' 命令的参数，这里是服务器入口文件 'index.js' 的路径。你需要将 '/path/to/MCP' 替换为你本地仓库的实际路径。
'"env"': 'env' 对象定义了 MCP 服务器运行时需要的环境变量：
- '"EDUBASE_API_URL"': EduBase 平台的 API 根 URL。
- '"EDUBASE_API_APP"': 你的 EduBase 集成应用的 App ID。
- '"EDUBASE_API_KEY"': 你的 EduBase 集成应用的 Secret Key。

基本使用方法

获取 EduBase API 凭据: 登录 EduBase 平台，在用户仪表板的 "Integrations" 菜单中，创建一个新的 "EduBase API" 集成，并获取 'EDUBASE_API_APP' (App ID) 和 'EDUBASE_API_KEY' (Secret Key)。
配置 MCP 客户端: 打开你的 MCP 客户端 (例如 Claude Desktop) 的配置文件 ('claude_desktop_config.json')，按照上述 "服务器配置" 示例，将 EduBase MCP 服务器添加到 'mcpServers' 列表中。请务必将占位符路径和凭据替换为你的实际值。
启动 MCP 客户端: 启动你的 MCP 客户端。客户端将自动连接到 EduBase MCP 服务器。
使用 MCP 工具: 在 MCP 客户端中，你可以使用 'edubase_' 开头的工具名称来调用 EduBase 平台的功能。例如，你可以使用 'edubase_get_user' 工具来查询用户信息，或使用 'edubase_post_question' 工具来创建新的题目。具体的工具及其参数请参考仓库中 'dist/tools' 目录下的文件，或者 EduBase 开发者文档。

关键词