MCP 服务器

JobNimbus MCP Server

clykins90

开发者工具

访问服务器

README

JobNimbus MCP 服务器

本项目提供了一个模型上下文协议 (MCP) 服务器，用于通过兼容的 AI 助手（如 Cursor 和 Claude）与 JobNimbus API 交互。

它允许 AI 代理通过标准化工具访问和操作 JobNimbus 数据（联系人、任务、工作、产品、工作流程、发票），并使用您的 JobNimbus API 密钥进行安全访问。

此服务器已发布在 npm 上，可以使用 npx 轻松运行。

设置说明

请按照以下说明为您的特定 AI 助手进行设置。

Cursor 编辑器设置

前提条件：
- 已安装 Cursor 编辑器。
- 已安装 Node.js 和 npm（npx 需要）。
- 您的 JobNimbus API 密钥。

配置 Cursor：

如果 ~/.cursor 目录不存在，请在您的主目录中创建它。
在此目录中创建一个名为 mcp.json 的文件（~/.cursor/mcp.json）。

将以下配置复制到 ~/.cursor/mcp.json 中：

{
  "mcpServers": {
    "jobnimbus-local-server": {
      "description": "JobNimbus MCP 服务器（需要 API 密钥）",
      "command": "npx",
      "args": ["jobnimbus-mcp-server"],
      "env": {
        "JOBNIMBUS_API_KEY": "your_api_key_here"
      }
    }
  }
}

重要提示： 将文件中的 "your_api_key_here" 替换为您的实际 JobNimbus API 密钥。

重启 Cursor：
- 完全退出并重启 Cursor 编辑器。
验证：
- Cursor 将在需要时使用 npx 自动运行服务器。
- 您应该在 Cursor 的 MCP 设置中或当代理建议工具时，看到 jobnimbus-local-server 列在可用工具下。
- 现在，您可以要求 Cursor 使用 JobNimbus 工具执行操作（例如，“使用 jobnimbus_list_contacts 列出我的 JobNimbus 联系人”）。

Claude 桌面应用设置

前提条件：
- 已安装 Claude 桌面应用。
- 已安装 Node.js 和 npm（npx 需要）。
- 您的 JobNimbus API 密钥。
配置 Claude：
- 找到 Claude 配置文件：
  - 在 Mac 上：~/Library/Application Support/Claude/claude_desktop_config.json
  - 在 Windows 上：%APPDATA%\Claude\claude_desktop_config.json
- 如果文件不存在，请创建它。如果文件存在，请仔细合并 mcpServers 部分。
- 添加以下配置：
```
{
  "mcpServers": {
    "jobnimbus-local-server": {
      "description": "JobNimbus MCP 服务器（需要 API 密钥）",
      "command": "npx",
      "args": ["jobnimbus-mcp-server"],
      "env": {
        "JOBNIMBUS_API_KEY": "your_api_key_here"
      }
    }
  }
}
```
- 重要提示： 将文件中的 "your_api_key_here" 替换为您的实际 JobNimbus API 密钥。
重启 Claude 应用：
- 完全退出并重启 Claude 桌面应用程序。
验证：
- Claude 现在应该能够发现和使用服务器提供的 JobNimbus 工具。

工作原理（对于两个助手）：

该配置告诉助手使用 npx 运行 jobnimbus-mcp-server。
如果服务器包尚未缓存，npx 会自动从 npm 下载最新版本。
助手会将您的 API 密钥从 env 部分注入到服务器进程中。

手动运行（高级 / 其他客户端）

如果您需要手动运行服务器以进行调试或用于其他潜在的 MCP 客户端（支持 stdio）：

设置 API 密钥环境变量：

export JOBNIMBUS_API_KEY=your_actual_api_key_here

运行服务器：
```
npx jobnimbus-mcp-server
```
服务器将侦听通过 stdin/stdout 进行的 MCP 通信。

已实现的工具

此服务器实现了与 JobNimbus API 端点对应的 MCP 工具：

联系人

jobnimbus_list_contacts: 获取联系人列表，可选择过滤
jobnimbus_get_contact: 按 ID 获取特定联系人
jobnimbus_create_contact: 创建新联系人
jobnimbus_update_contact: 更新现有联系人

任务

jobnimbus_list_jobs: 获取任务列表，可选择过滤
jobnimbus_get_job: 按 ID 获取特定任务
jobnimbus_create_job: 创建新任务
jobnimbus_update_job: 更新现有任务

任务

jobnimbus_list_tasks: 获取任务列表，可选择过滤
jobnimbus_get_task: 按 ID 获取特定任务
jobnimbus_create_task: 创建新任务
jobnimbus_update_task: 更新现有任务

产品

jobnimbus_list_products: 获取产品列表，可选择过滤
jobnimbus_get_product: 按 ID 获取特定产品
jobnimbus_create_product: 创建新产品
jobnimbus_update_product: 更新现有产品

工作流程

jobnimbus_get_all_workflows: 获取所有工作流程及其状态
jobnimbus_create_workflow: 创建新工作流程
jobnimbus_create_workflow_status: 创建新工作流程状态

发票

jobnimbus_list_invoices: 获取发票列表，可选择过滤
jobnimbus_get_invoice: 按 ID 获取特定发票
jobnimbus_create_invoice: 创建新发票
jobnimbus_update_invoice: 更新现有发票
jobnimbus_send_invoice: 通过电子邮件发送发票
jobnimbus_record_invoice_payment: 记录发票付款

开发

如果您想贡献或修改服务器：

克隆存储库：git clone <repository_url>
安装依赖项：cd jobnimbus-mcp-server && npm install
在 src/ 目录中进行更改。
构建：npm run build
在本地测试（需要 .env 文件或导出的 API 密钥）：
- 直接运行：npm start
- 使用自动重新加载运行：npm run dev
- 链接以进行全局测试：npm link（完成后记得 npm unlink -g jobnimbus-mcp-server）