Onx MCP Server

🚀 Onspring MCP 服務器

Onspring MCP 服務器是一個與 Onspring API 集成的 模型上下文協議 (MCP) 服務器實現，它能讓 AI 助手訪問和操作存儲在 Onspring 實例中的數據，為數據交互提供了便利。

🚀 快速開始

此服務器充當 AI 助手與 Onspring 實例之間的橋樑，藉助 Model Context Protocol 提供了豐富功能，如獲取應用程序及其字段列表、檢索應用程序記錄、運行查詢、訪問報告數據以及從附件字段檢索文件等。

✨ 主要特性

• 獲取應用程序及其字段的列表
• 從應用程序中檢索記錄
• 對應用程序運行查詢
• 訪問報告數據
• 從附件字段中檢索文件

📦 安裝指南

先決條件

• Node.js
• 帶有 API 訪問權限的 Onspring 實例
• 具備適當權限的 Onspring API 密鑰

安裝步驟

1. 全局安裝包：

npm install -g onx-mcp-server

或直接使用 npx：

npx onx-mcp-server

從源代碼構建

若需要從源代碼構建，可按以下步驟操作：

# 克隆倉庫
git clone https://github.com/your-username/onx-mcp-server.git
cd onx-mcp-server

# 安裝依賴項
npm install

# 構建項目
npm run build

# 啟動服務器
npm start

💻 使用示例

要使用該服務器，您需要在選擇的 MCP 客戶端中進行配置。每個 MCP 客戶端應提供有關設置 MCP 服務器的說明。同時，請確保所需的環境變量已正確設置。更多詳細信息請參見 配置 部分。

📚 詳細文檔

配置

服務器要求以下環境變量已設置：

連接至 Claude Desktop

Claude Desktop 是一個流行的 MCP 客戶端。要將 Onspring MCP 服務器連接到 Claude Desktop，請按照以下步驟操作：

1. 找到 claude_desktop_config.json 文件。有關如何找到此文件的更多信息，請參考 針對 Claude Desktop 用戶 的文檔。
2. 使用文本編輯器打開 claude_desktop_config.json 文件，並添加以下內容：

{
  "servers": [
    {
      "url": "http://localhost:3001"
    }
  ]
}

開發

設置開發環境

# 安裝依賴項
npm install

# 在開發模式下運行（監視更改）
npm run dev

測試

項目使用 Vitest 進行測試：

# 運行測試
npm test

# 帶有覆蓋率的測試
npm run test:coverage

# 帶 UI 的測試
npm run test:ui

檢查服務器

您可以使用 MCP 監視器來測試服務器：

npm run inspect

📄 許可證

該項目根據 MIT License 發佈 - 詳情請參見 LICENSE.md 文件。