内容
# corun-mcp-server
`corun-mcp-server` 是一个独立的 Python MCP 服务器，为外部 LLM 客户端提供对 [corun-ai](https://github.com/BNLNPPS/corun-ai) 实例的读写访问权限。
## 功能特点
- **浏览** 文档章节、提示和 AI 生成的页面。
- **提交** 新的提示并触发生成作业。
- **轮询** 作业状态并在完成后检索生成的页面。
- **基于令牌的身份验证** ，用于安全的机器间访问。
## 安装
```bash
pip install corun-mcp-server
```
或者从源代码安装：
```bash
git clone https://github.com/eic/corun-mcp-server
cd corun-mcp-server
pip install -e ".[dev]"
```
## 配置
在启动服务器之前，请设置以下环境变量：
| 变量名 | 描述 | 默认值 |
| --- | --- | --- |
| `CORUN_BASE_URL` | corun-ai 实例的基本 URL | *必填* |
| `CORUN_API_TOKEN` | 用于 `Authorization: Token` 身份验证的 API 令牌 | *必填* |
| `CORUN_POLL_INTERVAL` | 作业状态轮询之间的秒数 | `5` |
| `CORUN_POLL_TIMEOUT` | 等待作业完成的最大秒数 | `3600` |
当前目录中的 `.env` 文件将自动加载（请勿提交此文件）。
## 用法
### 标准输入输出传输（默认）
```bash
export CORUN_BASE_URL=https://epic-devcloud.org/doc
export CORUN_API_TOKEN=your-token
corun-mcp-server
```
### Claude 桌面版
添加到 `claude_desktop_config.json`：
```json
{
"mcpServers": {
"corun": {
"command": "corun-mcp-server",
"env": {
"CORUN_BASE_URL": "https://epic-devcloud.org/doc",
"CORUN_API_TOKEN": "<your-token>"
}
}
}
}
```
### Docker
```bash
docker run --rm -i \
-e CORUN_BASE_URL=https://epic-devcloud.org/doc \
-e CORUN_API_TOKEN=<your-token> \
ghcr.io/eic/corun-mcp-server
```
## 可用工具
### 读取工具
| 工具 | 描述 |
| --- | --- |
| `list_sections` | 列出所有活跃的文档章节 |
| `get_section` | 获取一个章节及其当前提示 |
| `get_prompt` | 获取特定提示和已发布的页面 |
| `get_page` | 获取页面的完整生成内容 |
| `list_job_definitions` | 列出可用的作业定义 |
| `get_job_status` | 获取生成作业的当前状态 |
### 写入工具
| 工具 | 描述 |
| --- | --- |
| `submit_prompt` | 创建新提示（无生成） |
| `generate_from_prompt` | 从现有提示触发生成作业 |
| `submit_and_generate` | 创建提示并立即触发生成 |
| `wait_for_job` | 轮询直到作业完成并返回结果 |
| `abort_job` | 取消正在运行的作业 |
## 开发
```bash
pip install -e ".[dev]"
# 运行测试
pytest tests/ -v --cov=corun_mcp_server --cov-report=term-missing
# 代码检查
ruff check src/ tests/
```
## 许可证
MIT — 请参阅 [LICENSE](LICENSE)。
