使用说明
Focalboard MCP服务器
模型上下文协议(stdio)服务器 焦板 REST API(/api/v2).
配置
复制 .env.example 到 .env 用于本地默认值,或导出shell中的变量。
环境变量(前缀 FOCALBOARD_):
| 变量 | 描述 |
|---|---|
BASE_URL |
服务器来源,例如。 http://localhost:8000 (没有 /api/v2 后缀)。 |
TOKEN |
会话令牌 Authorization: Bearer (之后 login 或单用户模式)。 |
MATTERMOST_USER_ID |
可选;对于Mattermost插件模式,设置 Mattermost-User-Id. |
全部 /api/v2 请求发送 X-Requested-With: XMLHttpRequest (服务器要求)。
安装
自 PyPI (首次发布后):
pip install focalboard-mcp-server
从克隆:
pip install -e .
跑
cd /path/to/focalboard_mcp_server
python -m venv .venv
.venv/bin/pip install -e .
export FOCALBOARD_BASE_URL=http://localhost:8000
export FOCALBOARD_TOKEN=your_session_token
.venv/bin/python -m focalboard_mcp_server
光标MCP(标准输入)
添加到MCP配置中(例如Cursor 设置→ MCP):
{
"mcpServers": {
"focalboard": {
"command": "/path/to/focalboard_mcp_server/.venv/bin/python",
"args": ["-m", "focalboard_mcp_server"],
"env": {
"FOCALBOARD_BASE_URL": "http://localhost:8000",
"FOCALBOARD_TOKEN": "your_session_token"
}
}
}
}
许可证
麻省理工学院——见 许可证.
出版(维护者)
- 开 PyPI,注册项目并添加 受信任的发布者 对于GitHub(
fatherabraham-hms/focalboard_mcp_server,工作流程publish-pypi.yml).看 PyPI信任的发布者. - 碰撞
version在pyproject.toml、承诺、推动main. - 创建一个 GitHub发布 (标记提交,例如。
v0.1.0).这 发布到PyPI 工作流上传sdist/rheel。
在第一个PyPI版本存在之前,请使用 pip install git+https://github.com/fatherabraham-hms/focalboard_mcp_server.git.
发展
虚拟环境存在于 .venv (带前导点),不是 venv.
.venv/bin/pip install -e ".[dev]"
.venv/bin/pytest tests/ -v
备注
focalboard_patch_card用途PATCH /api/v2/cards/{cardID}(直播路线);出版的《招摇》列出了一条不同的道路。focalboard_update_user_config用途 放/users/{userID}/config以匹配服务器。focalboard_upload_file发布多部分字段file到/teams/{teamID}/{boardID}/files.focalboard_hello和focalboard_ping呼叫/hello和/ping在服务器根目录下(不在/api/v2).