# CSUMCP
**Repository Path**: oftheloneliness/CSUMCP
## Basic Information
- **Project Name**: CSUMCP
- **Description**: 中南大学 CSU 校园API × MCP代理:你的全能校园数据引擎。 教务、图书馆、校车、校园卡一站式接入,可本地调用,也可直接走 MCP
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-12-06
- **Last Updated**: 2025-12-06
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://github.com/Akshay090/svg-banners)
[](https://cdl.migow.club/) [](https://www.npmjs.com/package/csu-mcp) [](./LICENSE)
# 中南大学 CSU 校园**API × MCP**代理
你的全能校园**数据引擎**,
教务、图书馆、校车、校园卡一站式接入,可本地调用,也可直接走 MCP。
**能做什么:**
- _自动整理成绩、排名、等级考试,一键生成简历/学习报告_
- _课表智能渲染,周视图、日视图随取_
- _校园卡流水统计,自动生成消费分析_
- _图书检索、座位参考、电子资源直达_
- _校车班次查询、路线导航可联动高德_
- _工具可返回可跳转的明细 URL,方便扩展或二次开发_
## [百宝箱智能体体验](https://tbox.alipay.com/inc/share/202512APDjTt07695207?platform=WebService)
使用百宝箱智能体 CSU Helper 进行快速体验(不过可能由于模型性能或者网速出现卡死的情况)
# 快速使用(推荐)
## 直接用 `npx` 一键拉起 API 和 stdio MCP:
**标准 MCP 配置示例**
```json
{
"mcpServers": {
"csu": {
"command": "npx",
"args": ["-y", "csu-mcp@latest"],
"env": {
"CSU_ID": "YOUR_CSU_ID",
"CSU_PWD": "YOUR_CSU_PWD",
"PORT": "12000",
"API_BASE_URL": "http://127.0.0.1:12000"
}
}
}
}
```
## 使用已经部署的 sse 服务器:
**标准 MCP 配置示例**
```json
{
"mcpServers": {
"csu": {
"type": "sse",
"url": "https://cdl.migow.club/mcp"
}
}
}
```
## MCP 安装:
在 Claude Code 中安装
运行命令(参考 Claude Code MCP 文档):
#### Claude Code 远端连接(SSE)
```sh
claude mcp add --transport sse csu https://cdl.migow.club/mcp
```
#### Claude Code 本地连接(STDIO)
```sh
claude mcp add --transport stdio csu \
--env CSU_ID=YOUR_CSU_ID \
--env CSU_PWD=YOUR_CSU_PWD \
--env PORT=12000 \
--env API_BASE_URL=http://127.0.0.1:12000 \
-- npx -y csu-mcp@latest
```
在 VS Code 中安装
[
](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22csumcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22csu-mcp%40latest%22%5D%7D)
在 VS Code MCP 配置中添加(参考 VS Code MCP 文档):
#### VS Code 远端连接
```json
"mcp": {
"servers": {
"csu": {
"type": "sse",
"url": "https://cdl.migow.club/mcp"
}
}
}
```
#### VS Code 本地连接
```json
"mcp": {
"servers": {
"csu": {
"type": "stdio",
"command": "npx",
"args": ["-y", "csu-mcp@latest"],
"env": {
"CSU_ID": "YOUR_CSU_ID",
"CSU_PWD": "YOUR_CSU_PWD",
"PORT": "12000",
"API_BASE_URL": "http://127.0.0.1:12000"
}
}
}
}
```
在 Kilo Code 中安装
Kilo Code 支持全局(`mcp_settings.json`)和项目级(`.kilocode/mcp.json`)配置,项目级优先生效。
## 手动配置(`.kilocode/mcp.json`)
#### 远程连接
```json
{
"mcpServers": {
"csu": {
"type": "sse",
"url": "https://cdl.migow.club/mcp"
}
}
}
```
#### 本地连接
```json
{
"mcpServers": {
"csu": {
"command": "npx",
"args": ["-y", "csu-mcp@latest"],
"env": {
"CSU_ID": "YOUR_CSU_ID",
"CSU_PWD": "YOUR_CSU_PWD",
"PORT": "12000",
"API_BASE_URL": "http://127.0.0.1:12000"
}
}
}
}
```
保存后在 Kilo Code 中刷新 MCP 服务器即可生效。
在 Claude Desktop 中安装
#### 远端连接
Settings > Connectors > Add Custom Connector,名称填 `CSUMCP`,URL 填 `https://cdl.migow.club/mcp`。
#### 本地连接
在 `claude_desktop_config.json` 中添加:
```json
{
"mcpServers": {
"csu": {
"command": "npx",
"args": ["-y", "csu-mcp@latest"],
"env": {
"CSU_ID": "YOUR_CSU_ID",
"CSU_PWD": "YOUR_CSU_PWD",
"PORT": "12000",
"API_BASE_URL": "http://127.0.0.1:12000"
}
}
}
}
```
在 OpenAI Codex 中安装
#### 本地连接(stdio)
在`~/.codex/config.toml`中:
```toml
[mcp_servers.csu]
command = "npx"
args = ["-y", "csu-mcp@latest"]
env = { CSU_ID = "YOUR_CSU_ID", CSU_PWD = "YOUR_CSU_PWD", PORT = "12000", API_BASE_URL = "http://127.0.0.1:12000" }
startup_timeout_ms = 20_000
```
默认:
- API 监听本地 `12000`端口
- MCP stdio 指向 `http://127.0.0.1:12000`
可用环境变量调整:
- `PORT`:API 端口(默认 12000)
- `API_BASE_URL`:MCP 访问的 API 基址(默认 `http://127.0.0.1:`)
- `CSU_ID` / `CSU_PWD`:统一认证学号/密码(设置后可覆盖 URL 中的 `:id/:pwd`)
- `MCP_PORT`: sse 开放的本地端口,**注意:此时并不用于 npx 的直接使用**
> [!NOTE]
> 在百宝箱里目前不支持通过环境变量传输账号密码,只能通过对话框传输
> 上述 env 均为可选;`CSU_ID/CSU_PWD` 供需认证的功能使用;`PORT` 为本地 API 端口;`API_BASE_URL` 为 MCP 访问基址。
> 目前不支持 streamhttp
# 本地开发
## 克隆 [github](https://github.com/chendaile/CSUMCP.git) 仓库
```sh
git clone https://github.com/chendaile/CSUMCP.git
npm install
npm run build
PORT= npm run start:api
# 启动api服务, 可选本地端口PORT, 默认12000
API_BASE_URL= MCP_PORT= npm run start:mcp:sse
# 启动sse mcp服务, 可选API_BASE_URL, 默认为本地12000端口, 可选MCP_PORT SSE端口
API_BASE_URL= npm run start:mcp:stdio
# 启动sse mcp服务, 可选API_BASE_URL, 默认为本地12000端口
```
## Docker 本地开发
```
docker pull oft-registry.cn-shanghai.cr.aliyuncs.com/oft/csumcp:latest
docker run -it --entrypoint /bin/sh oft-registry.cn-shanghai.cr.aliyuncs.com/oft/csumcp:latest
```
# 能力概览
- 教务:成绩、排名、课表、等级考试、培养计划、辅修信息。
- 校园卡:账户信息、近期开销流水(含明细 URL,金额换算为元)。
- 图书馆:电子资源检索、馆藏检索(含详情 URL)、座位校区/楼层信息(以及预约 URL)。
- 校车:班次查询,返回 id、途径站、详情链接,便于跳转查看。
# 工具列表(MCP)
- `grade`:成绩(term 可选,如 2024-2025-1)
- `rank`:专业排名
- `classes`:课表(term,week;week=0 为全周)
- `level_exam`:等级考试
- `student_plan`:培养计划
- `minor_info`:辅修报名与缴费
- `library_db_search`:电子资源检索
- `library_book_search`:馆藏检索
- `library_seat_campuses`:座位校区列表
- `ecard_card`:校园卡信息(余额等)
- `ecard_turnover`:校园卡流水(支持日期/金额范围筛选,返回简化字段与明细 URL)
- `bus`:校车查询(date,crs01/02 途径站)
说明:多数接口会返回可直接访问的明细 URL(如图书详情、校车班次详情、校园卡流水等),方便在外部工具中二次跳转或扩展操作;校车接口还会返回 `id`、`cross` 站点与班次详情链接。