Xano MCP Server H9l

🚀 Xano MCP 服务器

Xano MCP 服务器是一个用于与 Xano API 对接的模型上下文协议 (MCP) 服务器实现。它提供了一系列工具和资源，可通过 MCP 接口高效管理 Xano 数据库操作，为开发者带来便捷的开发体验。

🚀 快速开始

安装

# 克隆仓库
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
   

开发

# 构建项目
npm run build

# 在开发模式下运行
npm run dev

# 启动服务器
npm start

✨ 主要特性

• 安全认证：使用 Xano API 的安全认证，保障数据交互安全。
• 类型安全：基于 TypeScript 的类型安全 API 交互，提升开发效率与代码质量。
• 灵活配置：支持环境变量配置，方便不同环境部署。
• 标准接口：提供符合 MCP 标准的接口，便于集成。
• 工作区管理：具备工作区管理工具，高效管理工作空间。
• 表内容操作：支持表内容的创建、读取、更新操作。
• 错误处理：改进的错误处理机制，带详细消息，便于问题排查。

📦 安装指南

# 克隆仓库
git clone [your-repo-url]
cd xano_mcp

# 安装依赖项
npm install

📚 详细文档

项目结构

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. 提交拉取请求

💻 使用示例

基础用法

工作区创建

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" }
  ]
});

📄 许可证

本项目采用 ISC 许可证。