项目简介

Xano MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,它充当 Smithery 和 Xano 数据库之间的桥梁。通过这个服务器,你可以让 AI 模型(如 Claude)安全地访问和操作存储在 Xano 数据库中的数据。

主要功能点

  • Xano 数据库集成: 无缝连接 Xano 数据库,让 AI 可以安全地访问和操作存储在 Xano 中的数据。
  • 全面的数据库操作: 支持对 Xano 数据库进行全面的操作,包括实例、数据库(工作区)、表、记录和文件等多种资源的增删改查。
  • 丰富的工具集: 内置了预定义的工具,例如列出数据库实例、查询表内容、创建和更新记录等,方便 AI 应用调用。
  • 灵活的传输协议: 支持 stdio 和 WebSocket 两种 MCP 传输协议,可以根据不同的应用场景选择合适的通信方式。
  • 易于部署和配置: 可以通过简单的命令行参数或环境变量进行配置,支持本地运行和 Docker 部署,方便集成到各种 AI 应用环境中。

安装步骤

  1. 克隆仓库

    git clone https://github.com/roboulos/xano-mcp.git
    cd xano-mcp
  2. 安装依赖

    确保你的 Python 版本为 3.10 或更高,然后运行以下命令安装所需的 Python 包:

    pip install -r requirements.txt
  3. 获取 Xano API Token

    你需要一个有效的 Xano API Token 才能连接到你的 Xano 数据库。请在 Xano 后台获取 API Token。

服务器配置

MCP 客户端(如 Smithery)需要以下配置信息来连接到 Xano MCP 服务器。请将以下 JSON 配置填入 MCP 客户端的服务器配置中。

{
  "server_name": "xano-mcp",
  "command": "python",
  "args": ["-m", "src.xano_mcp", "--token", "<YOUR_XANO_API_TOKEN>"]
  // 请将 <YOUR_XANO_API_TOKEN> 替换为你的 Xano API 令牌
  // 你也可以将 XANO_API_TOKEN 设置为环境变量,此时 args 可以简化为 ["-m", "src.xano_mcp"]
  //
  // 可选参数:
  // "--transport": "websocket"  // 使用 WebSocket 传输,默认为 stdio
  // "--port": "8765"           // WebSocket 端口,默认为 8765
  // "--debug"                  // 启用调试模式,输出更详细的日志
}

配置参数说明:

  • 'server_name': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
  • 'command': 启动服务器的命令,这里使用 'python' 解释器。
  • 'args': 传递给 'python' 命令的参数列表,用于指定运行的模块和服务器配置。
    • '"-m", "src.xano_mcp"': 运行 'src/xano_mcp.py' 模块作为主程序。
    • '"--token", "<YOUR_XANO_API_TOKEN>"': 必需参数,用于指定 Xano API Token,请替换为你的实际 Token。你也可以选择将 'XANO_API_TOKEN' 设置为环境变量,这样可以避免在配置中暴露 Token。
    • '"--transport", "websocket"': 可选参数,指定使用 WebSocket 传输协议。如果不指定,默认使用 stdio。
    • '"--port", "8765"': 可选参数,当使用 WebSocket 传输时,指定服务器监听的端口。默认为 '8765'。
    • '"--debug"': 可选参数,启用调试模式,服务器会输出更详细的日志信息,方便开发和调试。

基本使用方法

  1. 启动 MCP 服务器

    根据上述配置,MCP 客户端会自动启动 Xano MCP 服务器。你也可以在本地手动启动服务器进行测试:

    使用 stdio 传输 (默认):

    python -m src.xano_mcp --token YOUR_XANO_API_TOKEN

    使用 WebSocket 传输:

    python -m src.xano_mcp --token YOUR_XANO_API_TOKEN --transport websocket --port 8765
  2. 在 MCP 客户端中使用工具

    一旦服务器成功启动并连接到 MCP 客户端,你就可以在客户端中使用预定义的工具来与 Xano 数据库进行交互。例如,你可以使用 'xano_list_tables' 工具列出指定数据库中的所有表,或者使用 'xano_browse_table_content' 工具浏览表中的数据记录。

    具体的工具列表和使用方法请参考仓库的 'README.md' 文件中 "Available Tools" 部分的说明。

注意事项

  • 安全性: 请务必妥善保管你的 Xano API Token,避免泄露。建议使用环境变量 'XANO_API_TOKEN' 来传递 Token,而不是直接 Hardcode 在配置文件或命令行中。
  • Xano 权限: 确保你的 Xano API Token 具有访问和操作你的数据库的权限。
  • Smithery 集成: 该服务器特别为 Smithery 平台设计,可以方便地集成到 Smithery 的工作流中,为 AI Agent 提供数据访问能力。

信息

分类

数据库与文件