JobNimbus API 服务器

JobNimbus MCP Server 是一个通过 Model Context Protocol (MCP) 与 JobNimbus API 交互的服务器,允许 AI 助手访问和操作 JobNimbus 数据(如联系人、任务、产品等)。

  • by clykins90
  • JavaScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 clykins90/jobnimbus-mcp-server

使用说明

JobNimbus MCP服务器

该项目提供了 模型上下文协议(MCP) 用于通过Cursor和Claude等兼容人工智能助手与JobNimbus API交互的服务器。

它允许人工智能代理通过标准化工具访问和操作JobNimbus数据(联系人、作业、任务、产品、工作流、发票),使用您的JobNimbusneneneba API密钥进行安全访问。

此服务器发布在npm上,可以使用以下命令轻松运行 npx.

安装说明

按照以下针对您的特定AI助手的说明进行操作。

光标编辑器设置

  1. 先决条件:

    • 已安装光标编辑器。
    • 已安装Node.js和npm(需要 npx).
    • 您的JobNimbus API密钥。
  2. 配置光标:

    • 创建目录 ~/.cursor 如果它不存在,请在您的主目录中。

    • 创建一个名为的文件 mcp.json 在此目录内(~/.cursor/mcp.json).

    • 将以下配置复制到 ~/.cursor/mcp.json:

      {
        "mcpServers": {
          "jobnimbus-local-server": {
            "description": "JobNimbus MCP Server (requires API key)",
            "command": "npx",
            "args": ["jobnimbus-mcp-server"],
            "env": {
              "JOBNIMBUS_API_KEY": "your_api_key_here"
            }
          }
        }
      }
      
    • 重要: 替换 "your_api_key_here" 在您的文件中 实际JobNimbus API密钥.

  3. 重新启动光标:

    • 完全退出并重新启动光标编辑器。
  4. 验证:

    • Cursor将使用以下命令自动运行服务器 npx 必要时。
    • 你应该看看 jobnimbus-local-server 在Cursor的MCP设置中的可用工具下列出,或者在代理建议工具时列出。
    • 现在,您可以要求Cursor使用JobNimbus工具执行操作(例如,“使用JobNimbus_List_contacts列出我的JobNimbus联系人”)。

Claude桌面应用程序的设置

  1. 先决条件:

    • 已安装克劳德桌面应用程序。
    • 已安装Node.js和npm(需要 npx).
    • 您的JobNimbus API密钥。
  2. 配置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 Server (requires API key)",
            "command": "npx",
            "args": ["jobnimbus-mcp-server"],
            "env": {
              "JOBNIMBUS_API_KEY": "your_api_key_here"
            }
          }
        }
      }
      
    • 重要: 替换 "your_api_key_here" 在您的文件中 实际JobNimbus API密钥.

  3. 重新启动Claude应用程序:

    • 完全退出并重新启动Claude桌面应用程序。
  4. 验证:

    • Claude现在应该能够发现和使用服务器提供的JobNimbus工具。

它是如何工作的(对于两个助手):

  • 配置告诉助手使用 npx 运行 jobnimbus-mcp-server.
  • npx 如果尚未缓存,则自动从npm下载服务器包的最新版本。
  • 助手从 env 进入服务器进程。

手动运行(高级/其他客户端)

如果您需要手动运行服务器进行调试或与支持stdio的其他潜在MCP客户端一起使用:

  1. 设置API密钥环境变量:
    export JOBNIMBUS_API_KEY=your_actual_api_key_here
    
  2. 运行服务器:
    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:根据发票记录付款

发展

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

  1. 克隆存储库: git clone <repository_url>
  2. 安装依赖项: cd jobnimbus-mcp-server && npm install
  3. 在 src/ 目录。
  4. 构建: npm run build
  5. 本地测试(需要 .env 文件或导出的API密钥):
    • 直接运行: npm start
    • 使用自动重新加载运行: npm run dev
    • 全球测试链接: npm link (记住 npm unlink -g jobnimbus-mcp-server 完成时)

许可证

麻省理工学院