MCP Workboard

io.github.crunchtools由 GitHub 账号 crunchtools 发布v0.6.1更新于 Oct 24, 2026

Secure MCP server for WorkBoard OKR and strategy execution platform

已验证STDIO仅桌面效率与工作流商业与电商

概览

AI 生成的概览

面向 WorkBoard OKR 与战略执行平台的本地 MCP 服务器,让助手读取和更新用户、目标、关键结果与工作流。

可以做什么
  • 查询用户:获取当前用户或按 ID 获取用户、列出全部用户、创建和更新用户
  • 读取目标:用户拥有的目标、按时间窗口查询团队目标、含关键结果的目标详情,以及按 ID 获取当前用户的目标
  • 创建带关键结果的目标,并列出或更新关键结果进度以完成每周 OKR 检查
  • 处理工作流:列出可访问或团队的工作流、读取详情与行动项、列出看板列、创建和更新工作流属性
  • 检查授权状态,在 OAuth 模式下发起浏览器授权并报告最近一次重定向的结果
适用场景
适合团队在 WorkBoard 中管理 OKR 与战略执行,并希望助手直接回答目标、关键结果和工作流相关问题,或记录进度更新、创建目标而无需切换应用。
运行要求
通过 PyPI 包 mcp-workboard-crunchtools(uvx 或 pip)或容器镜像在本地以 stdio 运行。需要 WorkBoard API 令牌,通过环境变量 WORKBOARD_API_TOKEN 提供;或使用 OAuth 模式,需 WORKBOARD_CLIENT_ID 与 WORKBOARD_CLIENT_SECRET,OAuth 重定向配置还涉及 WORKBOARD_OAUTH_REDIRECT_URI 和 WORKBOARD_TOKEN_STORE_PATH。需要访问 WorkBoard API 的网络连接。
安装前请注意
WorkBoard API 令牌是可访问组织 OKR 数据的凭据,应只放在环境变量中,避免写入文件或命令行参数。多个工具会写入数据:创建和更新用户、创建目标、更新关键结果进度、创建或更新工作流。列出和创建用户需要 Data-Admin 角色。OAuth 模式下令牌会保存到磁盘上的令牌存储文件。

安装

在 SourceWeft 中

  1. 打开 控制台中的 MCP Workboard,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

MCP WorkBoard CrunchTools

A secure MCP (Model Context Protocol) server for WorkBoard OKR and strategy execution platform.

Overview

This MCP server is designed to be:

  • Secure by default - Threat modeling, input validation, and token protection
  • No third-party services - Runs locally via stdio, your API token never leaves your machine
  • Cross-platform - Works on Linux, macOS, and Windows
  • Automatically updated - GitHub Actions monitor for CVEs and update dependencies
  • Containerized - Available at quay.io/crunchtools/mcp-workboard built on Hummingbird Python base image

Naming Convention

ComponentName
GitHub repocrunchtools/mcp-workboard
Containerquay.io/crunchtools/mcp-workboard
Python package (PyPI)mcp-workboard-crunchtools
CLI commandmcp-workboard-crunchtools
Module importmcp_workboard_crunchtools

Why Hummingbird?

The container image is built on the Hummingbird Python base image from Project Hummingbird, which provides:

  • Minimal CVE exposure - Built with a minimal package set, dramatically reducing attack surface
  • Regular updates - Security patches applied promptly
  • Optimized for Python - Pre-configured with uv package manager
  • Production-ready - Proper signal handling and non-root user defaults

Features

User Management (4 tools)

  • workboard_get_user_tool - Get a user by ID or the current authenticated user
  • workboard_list_users_tool - List all users (Data-Admin role required)
  • workboard_create_user_tool - Create a new user (Data-Admin role required)
  • workboard_update_user_tool - Update an existing user

Objective Management (5 tools)

  • workboard_get_objectives_tool - Get all objectives a user owns
  • workboard_get_team_objectives_tool - Get a team's objectives overlapping a date window, past quarters included (slow: reads every visible objective)
  • workboard_get_objective_details_tool - Get details for a specific objective with key results
  • workboard_get_my_objectives_tool - Get the current user's owned objectives by ID (recommended)
  • workboard_create_objective_tool - Create a new objective with key results (Data-Admin required)

Key Result Management (2 tools)

  • workboard_get_my_key_results_tool - List current user's key results with metric IDs and progress
  • workboard_update_key_result_tool - Update key result progress for weekly OKR check-ins

Workstream Management (6 tools)

  • workboard_get_workstreams_tool - Get team workstreams accessible to the authenticated user
  • workboard_get_workstream_activities_tool - Get workstream details with all action items
  • workboard_get_workstream_columns_tool - List the Kanban columns in use on a workstream
  • workboard_get_team_workstreams_tool - Get all workstreams belonging to a specific team
  • workboard_create_workstream_tool - Create a new workstream for a team
  • workboard_update_workstream_tool - Update workstream properties (name, dates, pace, health, priority)

Authorization (3 tools)

  • workboard_auth_status_tool - Report auth mode, token store, and whether the credential works (GET /user)
  • workboard_auth_start_tool - Return the WorkBoard authorize URL for browser approval (OAuth mode)
  • workboard_auth_result_tool - Report the outcome of the most recent authorization redirect

Installation

With uvx (Recommended)

bash
uvx mcp-workboard-crunchtools

With pip

bash
pip install mcp-workboard-crunchtools

With Container

bash
podman run -e WORKBOARD_API_TOKEN=your_token \    quay.io/crunchtools/mcp-workboard

Configuration

Getting a WorkBoard API Token

  1. Log in to your WorkBoard instance
  2. Navigate to Admin Settings > API Configuration
  3. Generate a JWT API token
  4. Copy the token immediately - store it securely

Add to Claude Code

bash
claude mcp add mcp-workboard \    --env WORKBOARD_API_TOKEN=your_token_here \    -- uvx mcp-workboard-crunchtools

Or for the container version:

bash
claude mcp add mcp-workboard \    --env WORKBOARD_API_TOKEN=your_token_here \    -- podman run -i --rm -e WORKBOARD_API_TOKEN quay.io/crunchtools/mcp-workboard

OAuth on a Server (Container Behind a Reverse Proxy)

In OAuth mode (WORKBOARD_CLIENT_ID + WORKBOARD_CLIENT_SECRET), a server reachable over HTTPS can be re-authorized without a shell:

  1. Register the public callback URL, e.g. https://workboard.example.com/callback, as the redirect URI of the WorkBoard app.
  2. Run the server with an HTTP transport and set WORKBOARD_OAUTH_REDIRECT_URI to that same URL. The proxy must route /callback to the server.
  3. Call workboard_auth_start_tool, open the URL it returns and approve. WorkBoard redirects to /callback; the server exchanges the code and saves the tokens to the token store. The authorization expires after 10 minutes.
  4. Call workboard_auth_status_tool to confirm (or workboard_auth_result_tool to see why it failed).
bash
podman run -p 8000:8000 \    -e WORKBOARD_CLIENT_ID -e WORKBOARD_CLIENT_SECRET \    -e WORKBOARD_OAUTH_REDIRECT_URI=https://workboard.example.com/callback \    -e WORKBOARD_TOKEN_STORE_PATH=/data/tokens.json -v workboard-tokens:/data:Z \    quay.io/crunchtools/mcp-workboard --transport streamable-http --host 0.0.0.0
VariableDefaultDescription
WORKBOARD_OAUTH_REDIRECT_URIunsetPublic URL of this server's /callback route. Required for workboard_auth_start_tool; the CLI login ignores it and uses http://localhost:8963/callback.
WORKBOARD_TOKEN_STORE_PATH~/.config/mcp-workboard/tokens.jsonWhere OAuth tokens are stored

Usage Examples

Get Current User

User: Who am I in WorkBoard?Assistant: [calls workboard_get_user with no args]

List All Users

User: List all WorkBoard usersAssistant: [calls workboard_list_users]

Get User Objectives

User: Show me objectives for user 12345Assistant: [calls workboard_get_objectives with user_id=12345]

Get Objective Details

User: Get details on objective 67890 for user 12345Assistant: [calls workboard_get_objective_details with user_id=12345, objective_id=67890]

Get My Objectives

User: Show me my objectives (IDs: 2900058, 2900075, 2901770)Assistant: [calls workboard_get_my_objectives with objective_ids=[2900058, 2900075, 2901770]]

List My Key Results

User: Show me my key resultsAssistant: [calls workboard_get_my_key_results]

Update Key Result Progress

User: Update key result 12345 to 75Assistant: [calls workboard_update_key_result with metric_id=12345, value="75"]

Create an Objective

User: Create an objective called "Increase retention" owned by [email protected]Assistant: [calls workboard_create_objective with name, owner, dates, and optional key_results]

List Workstreams

User: Show me my workstreamsAssistant: [calls workboard_get_workstreams]

Get Workstream Action Items

User: Show me the agenda for workstream 4130463Assistant: [calls workboard_get_workstream_activities with ws_id=4130463]

Security

This server was designed with security as a primary concern. See SECURITY.md for:

  • Threat model and attack vectors
  • Defense in depth architecture
  • Token handling best practices
  • Input validation rules

Key Security Features

  1. Token Protection

    • Stored as SecretStr (never accidentally logged)
    • Environment variable only (never in files or args)
    • Sanitized from all error messages
  2. Input Validation

    • Pydantic models for all inputs
    • Positive integer validation for IDs
    • Email validation for user creation
  3. API Hardening

    • Hardcoded API base URL (prevents SSRF)
    • TLS certificate validation
    • Request timeouts
    • Response size limits
  4. Automated CVE Scanning

    • GitHub Actions scan dependencies weekly
    • Automatic issues for security updates
    • Dependabot alerts enabled

Development

Setup

bash
git clone https://github.com/crunchtools/mcp-workboard.gitcd mcp-workboarduv sync

Run Tests

bash
uv run pytest

Lint and Type Check

bash
uv run ruff check src testsuv run mypy src

Build Container

bash
podman build -t mcp-workboard .

License

AGPL-3.0-or-later

Contributing

Contributions welcome! Please read SECURITY.md before submitting security-related changes.

Links

来源:README.md,提交 ea07dcf

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.6.1最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分