Xano MCP Server H9l

🚀 Xano MCP 服務器

Xano MCP 服務器是一個用於與 Xano API 對接的模型上下文協議 (MCP) 服務器實現。它提供了一系列工具和資源，可通過 MCP 接口高效管理 Xano 數據庫操作，為開發者帶來便捷的數據庫管理體驗。

✨ 主要特性

• 安全認證：使用 Xano API 的安全認證，保障數據交互安全。
• 類型安全：基於 TypeScript 的類型安全 API 交互，提升開發效率和代碼質量。
• 靈活配置：支持環境變量配置，方便不同環境下的部署和使用。
• 標準接口：提供符合 MCP 標準的接口，便於與其他系統集成。
• 工作區管理：具備工作區管理工具，可輕鬆管理不同工作區域。
• 表內容操作：支持表內容的創建、讀取、更新操作，滿足常見數據庫需求。
• 錯誤處理：改進的錯誤處理機制，帶詳細消息，方便排查問題。

📦 安裝指南

# 克隆倉庫
git clone [your-repo-url]
cd xano_mcp

# 安裝依賴項
npm install

🛠️ 配置說明

1. 複製示例環境文件：

   cp .env.example .env
   

2. 使用 Xano 憑據更新 .env 文件：

   XANO_API_KEY=your_api_key_here
   XANO_API_URL=your_xano_api_url
   NODE_ENV=development
   API_TIMEOUT=10000
   

💻 使用示例

基礎用法

工作區創建

const result = await createWorkSpace({
  name: "test", // 工作區名稱
  description: "測試工作區" // 工作區描述
});

表創建

const result = await createTable(wspId, {
  name: "users", // 表名稱
  columns: ["id", "name", "email"] // 表列
});

數據插入

const result = await insertData(wspId, tableId, {
  data: [
    { id: 1, name: "Alice", email: "alice@example.com" },
    { id: 2, name: "Bob", email: "bob@example.com" }
  ]
});

🚧 開發流程

# 構建項目
npm run build

# 在開發模式下運行
npm run dev

# 啟動服務器
npm start

📁 項目結構

xano_mcp/
├── src/
│   ├── api/
│   │   └── xano/
│   │       ├── client/       # API 客戶端實現
│   │       ├── models/       # 數據模型和類型
│   │       ├── services/     # API 服務實現
│   │       └── utils/        # 工具函數
│   ├── mcp/
│   │   ├── server/          # MCP 服務器實現
│   │   ├── tools/           # MCP 工具實現
│   │   └── types/           # 工具特定類型
│   ├── config.ts            # 配置管理
│   └── index.ts             # 入口文件
├── .env                     # 環境變量文件
├── .env.example            # 示例環境變量
└── package.json            # 項目依賴和腳本

📄 環境變量說明

🔧 錯誤處理

服務器提供詳細的錯誤消息，涵蓋以下常見錯誤類型：

• 參數無效
• 認證失敗
• API 請求失敗
• 內容驗證錯誤
• 未知工具請求

🔒 安全保障

• 敏感配置存儲：使用環境變量存儲敏感配置，避免敏感信息洩露。
• 秘密洩露防護：集成 TruffleHog 防止秘密洩露，保障代碼安全。
• 代碼倉庫安全：API 密鑰和敏感數據從未提交到代碼倉庫，確保數據安全。

🤝 貢獻指南

1. 創建功能分支。
2. 進行修改。
3. 提交拉取請求。

📄 許可證

本項目採用 ISC 許可證。