Jobnimbus MCP Server

🚀 JobNimbus MCP 服務器

本項目提供了一個 模型上下文協議 (MCP) 服務器，可藉助兼容的 AI 助手（例如 Cursor 和 Claude）與 JobNimbus API 進行交互。它能讓 AI 代理通過標準工具，使用您的 JobNimbus API 密鑰安全地訪問和操作 JobNimbus 數據（涵蓋聯繫人、工作、任務、產品、工作流程、發票等）。此服務器已發佈到 npm，可通過 npx 輕鬆運行。

🚀 快速開始

此服務器允許 AI 代理通過標準工具，使用您的 JobNimbus API 密鑰安全地訪問和操作 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

💻 使用示例

基礎用法

以下展示瞭如何使用工具實現部分功能的代碼示例：

# 假設這裡有一個 Python 客戶端庫可以調用這些 API
# 獲取所有聯繫人
contacts = listContacts()
# 根據 ID 獲取特定聯繫人
contact = getContact(123)

高級用法

# 高級場景說明：創建一個新的聯繫人並更新其信息
new_contact = {
    "name": "John Doe",
    "email": "johndoe@example.com"
}
created_contact = createContact(new_contact)
updated_contact = updateContact(created_contact["id"], {"email": "newemail@example.com"})

🔧 技術細節

此服務器實現了一系列工具方法，用於與 JobNimbus API 進行交互，以下是詳細的工具實現說明：

聯繫人

• 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 許可證。