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

开发

# 构建项目
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                     # 环境变量（不在 git 中）
├── .env.example            # 示例环境变量
└── tsconfig.json           # TypeScript 配置

可用的 MCP 工具

工作区工具

• get_workspaces: 列出所有可用的工作区

表格工具

• create_table: 在工作区中创建一个新表
• get_table_content: 从表中获取内容，支持分页
• add_table_content: 向表中添加新内容
• update_table_content: 更新表中的现有内容
• get_all_tables: 列出工作区中的所有表，包含详细信息

使用示例

使用工作区

// 列出可用的工作区
const result = await mcp.use_tool("get_workspaces", {});
console.log('Workspaces:', result);

管理表格

// 创建一个新表
const createResult = await mcp.use_tool("create_table", {
  workspaceId: 123,
  name: "MyTable"
});

// 向表中添加内容
const addResult = await mcp.use_tool("add_table_content", {
  workspaceId: 123,
  tableId: 456,
  content: {
    created_at: "2024-01-22T17:07:00.000Z"
  }
});

// 获取表格内容，支持分页
const getResult = await mcp.use_tool("get_table_content", {
  workspaceId: 123,
  tableId: 456,
  pagination: {
    page: 1,
    items: 50
  }
});

// 更新表格内容
const updateResult = await mcp.use_tool("update_table_content", {
  workspaceId: 123,
  tableId: 456,
  contentId: "789",
  content: {
    created_at: "2024-01-22T17:07:00.000Z"
  }
});

// 列出工作区中的所有表
const tables = await mcp.use_tool("get_all_tables", {
  workspaceId: 123
});
console.log('Tables:', tables);
// 返回一个包含表格详细信息的数组：
// [
//   {
//     id: number,
//     name: string,
//     description: string,
//     created_at: string,
//     updated_at: string,
//     guid: string,
//     auth: boolean,
//     tag: string[],
//     workspaceId: number
//   },
//   ...
// ]

环境变量

变量名	描述	是否必需	默认值
XANO_API_KEY	您的 Xano API 身份验证密钥	是	-
XANO_API_URL	Xano API 端点 URL	是	-
NODE_ENV	环境（开发/生产）	否	development
API_TIMEOUT	API 请求超时时间，单位为毫秒	否	10000

错误处理

服务器提供详细的错误消息，用于：

• 无效的参数
• 身份验证失败
• API 请求失败
• 内容验证错误
• 未知的工具请求

安全

• 环境变量用于敏感配置
• 包含 TruffleHog 配置以防止泄露密钥
• API 密钥和敏感数据永远不会提交到存储库

贡献

1. 创建一个特性分支
2. 进行更改
3. 提交一个拉取请求

许可证

ISC