Xano MCP Server 使用说明

项目简介

Xano MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在通过 MCP 协议与 LLM 客户端交互,提供访问和操作 Xano 后端数据库的能力。它允许 LLM 应用安全地管理 Xano 工作区和表格数据,例如检索数据、创建表格等。

主要功能点

  • 工作区管理: 支持列出 Xano 工作区。
  • 表格数据管理: 支持创建表格、获取表格内容、添加表格内容、更新表格内容以及列出工作区中的所有表格。
  • MCP 协议兼容: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的 LLM 客户端对接。
  • 基于 Xano API: 通过工具 (Tools) 的形式封装了对 Xano API 的调用,方便 LLM 客户端使用。
  • 环境配置: 通过 '.env' 文件进行 API 密钥和 URL 等敏感信息的配置。

安装步骤

  1. 克隆仓库

    git clone https://github.com/SarimSiddd/xano_mcp
    cd xano_mcp
  2. 安装依赖 确保你已经安装了 Node.js 和 npm。在项目根目录下运行:

    npm install
  3. 配置环境变量 复制 '.env.example' 文件并重命名为 '.env',然后根据你的 Xano API 凭据修改 '.env' 文件中的配置项:

    cp .env.example .env

    编辑 '.env' 文件,填入你的 Xano API 密钥和 API URL:

    XANO_API_KEY=你的Xano_API_密钥
    XANO_API_URL=你的Xano_API_URL

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 Xano MCP Server。客户端需要配置 'command' 和 'args' 来启动服务器。

{
  "serverName": "Xano MCP Server",  // MCP 服务器名称,可自定义
  "command": "npm",           // 启动命令,使用 npm
  "args": ["start"]          // 启动参数,运行 npm start 启动服务器
  // 确保服务器运行前已配置好 .env 文件,包含 XANO_API_KEY 和 XANO_API_URL 环境变量
}

基本使用方法

  1. 启动服务器 在项目根目录下,运行以下命令启动 Xano MCP Server:

    npm start

    服务器成功启动后,会在控制台输出 "Xano MCP server running on stdio"。

  2. 使用 MCP 客户端调用工具 使用兼容 MCP 协议的 LLM 客户端,配置上述服务器连接信息。客户端可以通过 'list_tools' 请求获取可用工具列表及其参数定义。然后,可以使用 'call_tool' 请求调用具体的工具,例如:

    • 列出工作区: 调用 'get_workspaces' 工具,无需参数。
    • 创建表格: 调用 'create_table' 工具,需要提供 'workspaceId' (工作区ID) 和 'name' (表格名称) 等参数。
    • 获取表格内容: 调用 'get_table_content' 工具,需要提供 'tableId' (表格ID) 和 'workspaceId' (工作区ID) 等参数。

    具体的工具名称、参数和使用示例,请参考仓库的 README 文档和代码中的工具定义部分。

信息

分类

开发者工具