OpenProject的独立MCP服务器
______________________________________________________________________
🇷🇺 俄语
Standalone MCP服务器，用于将OpenProject与Cursor IDE集成。完全本地运行，无需部署其他服务器进行处理。
描述
此MCP服务器允许Cursor IDE通过Model Context Protocol直接与OpenProject实例通信。服务器完全在本地运行，不需要部署到云平台。
安装
通过NPM安装（建议发布后）
在NPM中发布包后，将其全局安装：
npm install -g mcp-openproject-standalone或本地到项目：
npm install mcp-openproject-standalone依赖项将自动与包一起安装。
源代码安装
如果您已经克隆了存储库或希望使用本地版本：
自动依赖关系设置
依赖关系建立 自动 第一次启动MCP服务器时。只需配置MCP配置（见下文），并在第一次连接时自动安装依赖项。
手动依赖关系设置（可选）
如果要手动设置依赖项：
npm install备注： 如果您打算使用选项C npm link （见下文），您必须使脚本可执行：
chmod +x index.js如果您使用选项C node index.js 在MCP配置中，此步骤不是必需的。
更新包
初始安装后，可以将包更新到最新版本。
使用NPX更新
如果您使用 npx 在MCP配置中，每次启动时都会自动更新到最新版本。无需采取进一步行动。
全球安装更新
如果您在全球范围内安装了软件包 npm install -g，用以下命令更新：
npm update -g mcp-openproject-standalone或者重新安装最新版本：
npm install -g mcp-openproject-standalone@latest本地安装更新
如果包本地安装在项目中：
npm update mcp-openproject-standalone或者重新安装最新版本：
npm install mcp-openproject-standalone@latest检查当前版本
要查看当前安装的版本：
npm list -g mcp-openproject-standalone对于本地安装：
npm list mcp-openproject-standalone要了解NPM的最新可用版本：
npm view mcp-openproject-standalone version更新后
更新包后，重新启动Cursor IDE以使更改生效。
配置Cursor
将以下配置添加到MCP Cursor文件中（~/.cursor/mcp.json 或 ~/.config/cursor/mcp.json):
通过NPX自动安装（推荐）
使用 npx 用于自动安装和运行包。如果没有安装包， npx 自动下载并运行：
{
"mcpServers": {
"openproject": {
"command": "npx",
"args": [
"-y",
"mcp-openproject-standalone"
],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}优点：
- ✅ 第一次运行时自动安装包
- ✅ 无需预安装
- ✅ 自动更新到最新版本
- ✅ 缓存包以便以后运行
备注： 旗 -y 自动确认包安装，无需查询。
通过NPM安装（全球或本地）
如果您已经在全球安装了软件包：
npm install -g mcp-openproject-standalone然后可以使用配置：
{
"mcpServers": {
"openproject": {
"command": "mcp-openproject-standalone",
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}备注： 在全球范围内（npm install -g（团队） mcp-openproject-standalone 可以从任何地方访问。本地安装时，请使用完整路径 node_modules/.bin/mcp-openproject-standalone 或者使用 npx mcp-openproject-standalone.
如果您使用本地源代码版本
选项1：通过NPM链接
npm link然后可以使用配置：
{
"mcpServers": {
"openproject": {
"command": "mcp-openproject-standalone",
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}选项2：直接文件路径
{
"mcpServers": {
"openproject": {
"command": "node",
"args": [
"/absolute/path/to/mcp-openproject-standalone/index.js"
],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}可用功能
- list_项目 -获取所有项目列表
- get_工程 -通过ID获取项目详细信息
- list_work_packages -获取项目任务列表
- get_work_package -通过ID获取任务详细信息
- 创建工作包 创建新任务
- update_work_package -更新现有任务
- list_status -获取OpenProject中所有可用状态的列表
- get_available_status 获取特定任务（Workflow）的可用状态。返回当前状态和可以为此任务设置的所有状态
环境变量
可以通过两种方式指定环境变量：
1.MCP配置（推荐）
添加部分 env 在文件中配置MCP ~/.cursor/mcp.json 或 ~/.config/cursor/mcp.json:
{
"mcpServers": {
"openproject": {
"command": "node",
"args": ["/absolute/path/to/mcp-openproject-standalone/index.js"],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}这种方法很方便，因为所有设置都存储在一个地方。
2.通过系统环境变量
您还可以在启动前指定系统中的环境变量：
export OPENPROJECT_BASE_URL="https://your-openproject-instance.com"
export OPENPROJECT_API_KEY="your-api-token-here"支持的变量：
OPENPROJECT_BASE_URL或OPENPROJECT_URLOpenProject的URLOPENPROJECT_API_KEY或OPENPROJECT_API_TOKENOpenProject的API令牌
使用
设置后，您可以使用Cursor：
- “向我展示OpenProject的所有项目”
- 显示ID 123项目中的所有任务
- 在项目1中创建一个名为“新任务”的任务
- “更新任务#123”
- 显示所有可用状态
- “我可以为任务123设置哪些状态？”
优势
- ✅ 完全独立-本地工作
- ✅ 不需要部署到NetLify
- ✅ 读写支持（CRUD操作）
- ✅ 易于安装和配置
- ✅ 完全代码控制
______________________________________________________________________
🇬🇧 英语
用于将OpenProject与Cursor IDE集成的独立MCP服务器。完全在本地工作，无需部署在Netlify或其他云平台上。
描述
此MCP服务器允许Cursor IDE通过模型上下文协议直接与OpenProject实例交互。服务器完全在本地运行，不需要部署在云平台上。
安装
通过npm安装（推荐，发布后）
包发布到npm后，全局安装：
npm install -g mcp-openproject-standalone或者在项目的本地：
npm install mcp-openproject-standalone依赖项将随软件包自动安装。
从源代码安装
如果您克隆了存储库或希望使用本地版本：
自动依赖项安装
已安装依赖项 自动地 在MCP服务器的第一次运行时。只需配置MCP设置（见下文），依赖项将在第一次连接时自动安装。
手动依赖项安装（可选）
如果您想提前手动安装依赖项：
npm install注： 如果你打算使用 npm link 选项（见下文），您需要使脚本可执行：
chmod +x index.js如果你使用 node index.js MCP配置中的选项，则不需要此步骤。
更新包
初始安装后，您可以将软件包更新到最新版本。
使用npx时更新
如果你使用 npx 在MCP配置中，每次运行时，包都会自动更新到最新版本。无需采取额外行动。
使用全局安装进行更新
如果您通过以下方式全局安装了该软件包 npm install -g，更新为：
npm update -g mcp-openproject-standalone或者重新安装最新版本：
npm install -g mcp-openproject-standalone@latest使用本地安装进行更新
如果该包在项目中本地安装：
npm update mcp-openproject-standalone或者重新安装最新版本：
npm install mcp-openproject-standalone@latest正在检查当前版本
要查看当前安装的版本：
npm list -g mcp-openproject-standalone或用于本地安装：
npm list mcp-openproject-standalone要在npm上查看最新可用版本：
npm view mcp-openproject-standalone version更新后
更新包后，重新启动Cursor IDE以使更改生效。
光标中的配置
将以下配置添加到MCP游标文件中(~/.cursor/mcp.json 或 ~/.config/cursor/mcp.json):
通过npx自动安装（推荐）
使用 npx 用于自动安装和运行软件包。如果未安装该包， npx 将自动下载并运行它：
{
"mcpServers": {
"openproject": {
"command": "npx",
"args": [
"-y",
"mcp-openproject-standalone"
],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}优势：
- ✅ 首次运行时自动安装软件包
- ✅ 无需预安装
- ✅ 自动更新到最新版本
- ✅ 后续运行的包缓存
注： 这 -y 标志自动确认软件包安装，无需提示。
如果通过npm安装（全局或本地）
如果您已经全局安装了该软件包：
npm install -g mcp-openproject-standalone然后，在配置中，您可以使用：
{
"mcpServers": {
"openproject": {
"command": "mcp-openproject-standalone",
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}注： 全球安装(npm install -g)，the mcp-openproject-standalone 命令将在任何地方可用。使用本地安装时，请使用完整路径 node_modules/.bin/mcp-openproject-standalone 或使用 npx mcp-openproject-standalone.
如果使用源代码的本地版本
选项1：通过npm链接
npm link然后，在配置中，您可以使用：
{
"mcpServers": {
"openproject": {
"command": "mcp-openproject-standalone",
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}选项2：文件的直接路径
{
"mcpServers": {
"openproject": {
"command": "node",
"args": [
"/absolute/path/to/mcp-openproject-standalone/index.js"
],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}可用功能
- list_项目 -获取所有项目的列表
- get_工程 -按ID获取项目详细信息
- list_work_packages -获取项目中的工作包列表
- get_work_package -按ID获取工作包详细信息
- 创建工作包 -创建新的工作包
- update_work_package -更新现有工作包
- list_status -获取OpenProject中所有可用状态的列表
- get_available_status -获取特定工作包（工作流）的可用状态。返回当前状态和可以为此工作包设置的所有状态
环境变量
环境变量可以通过两种方式设置：
1.在MCP配置中（推荐）
添加 env 文件中MCP配置的部分 ~/.cursor/mcp.json 或 ~/.config/cursor/mcp.json:
{
"mcpServers": {
"openproject": {
"command": "node",
"args": ["/absolute/path/to/mcp-openproject-standalone/index.js"],
"env": {
"OPENPROJECT_BASE_URL": "https://your-openproject-instance.com",
"OPENPROJECT_API_KEY": "your-api-token-here"
}
}
}
}这种方法很方便，因为所有设置都存储在一个地方。
2.通过系统环境变量
您还可以在运行之前在系统中设置环境变量：
export OPENPROJECT_BASE_URL="https://your-openproject-instance.com"
export OPENPROJECT_API_KEY="your-api-token-here"支持的变量：
OPENPROJECT_BASE_URL或OPENPROJECT_URL-OpenProject实例的URLOPENPROJECT_API_KEY或OPENPROJECT_API_TOKEN-来自OpenProject的API令牌
用法
配置后，您可以在Cursor中使用：
- “显示OpenProject中的所有项目”
- “显示ID为123的项目中的所有工作包”
- 在项目1中创建标题为“新建任务”的工作包
- “更新工作包#123”
- “显示所有可用状态”
- “可以为工作包#123设置哪些状态？”
优势
- ✅ 完全独立-在本地工作
- ✅ 无需在Netlify上进行部署
- ✅ 读写支持（CRUD操作）
- ✅ 安装和配置简单
- ✅ 完全控制代码