mcpField
O
OpenProject

OpenProject

本地服务
github.com/alex13slem生产力015 周前更新

关于 OpenProject

OpenProject MCP server 通过 OpenProject API v3 将 MCP 客户端连接到项目和工作包管理功能。其 41 个工具还涵盖文件、看板、用户、通知和参考数据,并为读写及破坏性操作添加注解。

主要功能

  1. 01项目增删改查与筛选
  2. 02工作包搜索和编辑
  3. 03附件上传与读取
  4. 04关联和关注者管理
  5. 05用户、通知与看板
  6. 06受限 API 透传

适用场景

  1. 01查找并更新工作包
  2. 02上传或查看附件
  3. 03管理项目关注者和关联
  4. 04检查通知与看板数据

MCP 相关

通过 stdio MCP 服务提供 41 个用于 OpenProject API v3 的工具。工具注解标识读、写和破坏性操作,供兼容客户端采用相应策略。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"alex13slem-openproject": {
"command": "npx",
"args": [
"-y",
"openproject-codex-plugin"
],
"env": {
"OPENPROJECT_URL": "<OPENPROJECT_URL>",
"OPENPROJECT_API_TOKEN": "<OPENPROJECT_API_TOKEN>",
"OPENPROJECT_PAGE_SIZE": "<OPENPROJECT_PAGE_SIZE>",
"OPENPROJECT_TIMEOUT_MS": "<OPENPROJECT_TIMEOUT_MS>",
"OPENPROJECT_AUTH_MODE": "<OPENPROJECT_AUTH_MODE>",
"OPENPROJECT_ALLOWED_UPLOAD_DIRS": "<OPENPROJECT_ALLOWED_UPLOAD_DIRS>"
}
}
}
}
启动命令npx -y openproject-codex-plugin
需要配置的环境变量
OPENPROJECT_URLRoot URL of the OpenProject instance
OPENPROJECT_API_TOKEN密钥OpenProject API token
OPENPROJECT_PAGE_SIZEDefault page size from 1 to 100
OPENPROJECT_TIMEOUT_MSRequest timeout in milliseconds from 1000 to 300000
OPENPROJECT_AUTH_MODE密钥API-token authentication mode: basic for broad compatibility or bearer for OpenProject 17.2+
OPENPROJECT_ALLOWED_UPLOAD_DIRSPlatform-separated directories from which attachment files may be read; defaults to the process working directory

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npmopenproject-codex-plugin0.5.0

工具

41

收录的工具列表 · 更新于 2 周前

参数类型必填说明
querystring否不区分大小写的名称或标识符片段;与筛选条件组合时使用 AND
offsetinteger否
sortByarray否
filtersarray否
pageSizeinteger否

详细介绍

OpenProject MCP 服务

一个功能全面、支持写入的 OpenProject API v3 模型上下文协议服务。它提供 41 个专用工具,涵盖项目、工作包、附件、关系、看板、用户、关注者、通知和参考数据。

附件工具可以列出工作包中的文件并获取其内容。基于文本的文件会直接返回;二进制文件则作为嵌入式 MCP 资源返回。每个请求的上传和下载均有大小限制。

此软件包作为 OpenProject for Codex 的一部分维护,该项目还包括 Codex 工作流指南和便携式安装程序。

使用 MCP 客户端运行

配置以下环境变量:

  • OPENPROJECT_URL:OpenProject 实例的根 URL;
  • OPENPROJECT_API_TOKEN:仅具有所需权限的 API 令牌。

现有 MCP 配置也可以使用 OPENPROJECT_BASE_URL 和 OPENPROJECT_API_KEY 作为兼容别名。

可选设置:

  • OPENPROJECT_PAGE_SIZE:默认集合页面大小,范围为 1 到 100(默认值:25);
  • OPENPROJECT_TIMEOUT_MS:请求超时时间,范围为 1000 到 300000 毫秒(默认值:30000);
  • OPENPROJECT_AUTH_MODE:basic 可提供广泛兼容性(默认值),或为 OpenProject 17.2 及更高版本使用 bearer。
  • OPENPROJECT_ALLOWED_UPLOAD_DIRS:上传工具可读取文件的平台专用目录列表(默认值:当前工作目录)。

然后使用以下命令启动 stdio 服务:

npx -y openproject-codex-plugin

MCP 配置示例:

{
  "mcpServers": {
    "openproject": {
      "command": "npx",
      "args": ["-y", "openproject-codex-plugin"],
      "env": {
        "OPENPROJECT_URL": "https://tasks.example.com",
        "OPENPROJECT_API_TOKEN": "your-api-token"
      }
    }
  }
}

切勿提交 API 令牌,也不要将其包含在公开日志和屏幕截图中。

功能

  • 项目 CRUD、计数、原生筛选、排序和分页。
  • 工作包搜索、CRUD、评论、活动历史、排期、估算、进度、层级结构、受派人、负责人、优先级、状态和版本。
  • 附件列表、经身份验证的读取、本地文件上传和删除。
  • 关系和关注者管理。
  • 当前用户查询、用户搜索,以及权限感知的可用受派人查询。
  • 应用内通知和 Kanban 风格看板查看。
  • 状态、优先级、类型和版本发现。
  • 仅限 GET 的受限直通访问 /api/v3 下未覆盖的路径。

读取、写入和破坏性工具都带有 MCP 注解,以便兼容客户端应用适当的确认策略。集合响应包含 total、count、offset、pageSize 和 hasMore 元数据。

许可证

MIT

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。