Yokan董事会MCP
本项目是Yokan Kanban Board API的模型上下文协议（MCP）服务器。它为AI代理提供了一个基于工具的界面，用于与看板板、列和任务进行交互和管理。
特性
- 董事会管理层： 创建、检索、更新和删除看板。
- 栏目管理： 在板内创建、检索、更新、重新排序和删除列。
- 任务管理： 创建、检索、更新、移动和删除任务。
- 代理就绪： 设计用于AI代理通过主控制协议使用。
技术栈
入门指南
构建和运行Docker镜像
对于新用户或希望在不设置开发环境的情况下运行服务器的用户，我们建议使用Docker。
- 构建Docker镜像：
docker build -t yokanboard/yokan-mcp .- 运行Docker容器：
docker run -p 8888:8888 --name yokan-mcp -e YOKAN_API_BASE_URL=http://your-yokan-api-host:port/api yokanboard/yokan-mcp确保更换 http://your-yokan-api-host:port/api 使用Yokan API实例的实际URL。
MCP客户端配置
带流式传输的Gemini CLI
创建 .gemini/settings.json 内容如下：
{
"mcpServers": {
"yokan-board": {
"httpUrl": "http://[your-yokan-mcp-host]:8888/mcp",
"headers": {
"Authorization": "Bearer [TOKEN]",
"accept": "application/json"
}
}
}
}VS代码复制与标准传输
创建 .vscode/mcp.json 包含以下内容的文件：
{
"servers": {
"yokan-board": {
"type": "stdio",
"command": "uv",
"args": [
"run",
"--directory",
"/full/path/to/yokan-board-mcp-project-folder/yokan-board-mcp",
"-m",
"src.main",
"--stdio"
]
}
}
}发展
先决条件
- Python 3.8+
uv（用于管理Python环境）- 访问正在运行的实例 Yokan API.
设置
- 克隆存储库：
git clone https://github.com/yokan-board/yokan-board-mcp.git
cd yokan-board-mcp- 创建并激活虚拟环境：
uv venv
source .venv/bin/activate- 安装依赖项：
uv sync配置
- 创建一个
.env通过复制文件.env.example:
cp .env.example .env- 编辑
.env文件指向您的Yokan API实例：
YOKAN_API_BASE_URL=http://your-yokan-api-host:port/api运行服务器
要启动MCP服务器进行开发，请运行以下命令：
uvicorn src.main:app --host localhost --port 8888 --reload测试
要运行集成测试，您需要有一个正在运行的Yokan API实例和一个测试用户。测试配置为使用用户名 user 和密码 password.
确保你的 .env 文件已正确配置 YOKAN_API_BASE_URL.
使用以下命令运行测试：
make test可用工具
MCP服务器公开了以下用于管理Yokan看板的工具：
| 类别 | 工具 |
|---|---|
| 董事会 | get_boards, get_board, create_board, update_board, delete_board |
| 列 | create_column, get_columns, update_column, reorder_columns, delete_column, update_column_color |
| 任务 | create_task, create_tasks, get_tasks, update_task, move_task, delete_task |
用法示例
您可以使用以下命令与MCP服务器交互 fastmcp 客户端库。
认证
要使用这些工具，首先需要从Yokan API实例获取JWT令牌。您可以通过发送 POST 请求 /login Yokan API的终点。
示例使用 curl:
curl -X POST \
-H "Content-Type: application/json" \
-d '{"username": "your_username", "password": "your_password"}' \
http://localhost:3001/api/v1.1/login示例：与MCP服务器交互
一个Python示例演示如何使用 fastmcp 与Yokan MCP服务器交互的客户端可以在 examples/mcp_client.py.
版权
Yokan董事会MCP由以下人员创建： 朱利安·I·卡米尔
©版权所有2025朱利安·I·卡米尔。保留所有权利。
许可证
Yokan Board MCP提供双重许可：
- AGPLv3：可根据GNU Affero通用公共许可证版本3的条款自由使用、修改和分发（请参阅 许可证。AGPLv3)
- 商业许可证：适用于希望在没有AGPLv3版权要求的情况下使用Yokan的组织（见 许可证。商业的)
有关商业用途许可的信息，请发送电子邮件至：yokan.board@gmail.com