jobnimbus-mcp-server

🚀 JobNimbus MCP 服务器

本项目提供了一个 模型上下文协议 (MCP) 服务器，可借助兼容的 AI 助手（如 Cursor 和 Claude）与 JobNimbus API 实现交互。通过使用您的 JobNimbus API 密钥进行安全访问，该服务器允许 AI 代理利用标准工具对 JobNimbus 数据（包括联系人、工作、任务、产品、工作流程、发票等）进行访问和操作。此外，此服务器已发布到 npm，可通过 npx 轻松运行。

🚀 快速开始

按照以下步骤为特定的 AI 助手进行设置。

用于 Cursor Editor 的设置

1. 先决条件：
   • 已安装 Cursor Editor。
   • 已安装 Node.js 和 npm（需要 npx）。
   • 拥有您的 JobNimbus API 密钥。
2. 配置 Cursor：
   • 若主目录中不存在 ~/.cursor 目录，则创建该目录。
   • 若该目录中不存在 mcp.json 文件，则创建该文件。
   • 将以下内容添加到 mcp.json 文件中：

{
    "jobnexus": {
        "apiEndpoint": "YOUR_JOBNEXUS_API_ENDPOINT",
        "apiKey": "YOUR_JOBNEXUS_API_KEY"
    }
}

3. 启动 Cursor：
   • 在终端中运行：

npx jobnexus

用于 Claude 的设置

1. 先决条件：
   • 已安装 Claude。
   • 已安装 Node.js 和 npm（需要 npx）。
   • 拥有您的 JobNimbus API 密钥。
2. 配置 Claude：
   • 在终端中运行：

npx jobnexus

✨ 主要特性

该服务器提供了一系列工具，可对 JobNimbus 中的不同数据类型进行操作：

• 联系人：
  • listContacts()：获取所有联系人。
  • getContact(id)：根据 ID 获取特定联系人。
  • createContact(contact)：创建新联系人。
  • updateContact(id, contact)：更新现有联系人。
• 工作：
  • listJobs()：获取所有工作。
  • getJob(id)：根据 ID 获取特定工作。
  • createJob(job)：创建新工作。
  • updateJob(id, job)：更新现有工作。
• 任务：
  • listTasks()：获取所有任务。
  • getTask(id)：根据 ID 获取特定任务。
  • createTask(task)：创建新任务。
  • updateTask(id, task)：更新现有任务。
• 产品：
  • listProducts()：获取所有产品。
  • getProduct(id)：根据 ID 获取特定产品。
  • createProduct(product)：创建新产品。
  • updateProduct(id, product)：更新现有产品。
• 工作流程：
  • getAllWorkflows()：获取所有工作流程及其状态。
  • createWorkflow(workflow)：创建新工作流程。
  • createWorkflowStatus(status)：创建新工作流程状态。
• 发票：
  • listInvoices()：获取所有发票。
  • getInvoice(id)：根据 ID 获取特定发票。
  • createInvoice(invoice)：创建新发票。
  • updateInvoice(id, invoice)：更新现有发票。
  • sendInvoice(id)：通过电子邮件发送特定发票。
  • recordPayment(id, payment)：记录对特定发票的付款。

📦 安装指南

如果您想贡献或修改服务器，可按以下步骤操作：

1. 克隆仓库：git clone <repository_url>
2. 安装依赖项：cd jobnexus-mcp-server && npm install
3. 修改 src/ 目录中的内容。
4. 构建：npm run build
5. 本地测试（需要 .env 文件或导出的 API 密钥）：
   • 直接运行：npm start
   • 带自动重载运行：npm run dev
   • 链接进行全局测试：npm link（完成记得运行 npm unlink -g jobnexus-mcp-server）

📄 许可证

本项目采用 MIT 许可证。