使用说明

项目简介

本Simple Xano MCP Server是一个基于Model Context Protocol (MCP) 的服务器实现,旨在简化LLM客户端与Xano 数据库的集成。它通过MCP协议,将Xano数据库的功能以标准化的方式暴露给LLM,使得LLM可以方便地访问和操作Xano数据库中的数据和元数据。

主要功能点

  • Xano实例管理: 列出和查看Xano实例的详细信息。
  • 数据库浏览: 列出指定Xano实例中的数据库(工作区)。
  • 数据表操作: 列出、查看、创建、更新和删除数据库中的数据表。
  • 数据表结构管理: 获取数据表结构、添加、重命名和删除字段。
  • 数据表索引管理: 列出、创建和删除数据表索引(包括btree、unique和search索引)。
  • 数据内容操作: 浏览、搜索、获取、创建、更新和批量操作数据表中的记录。
  • 文件管理: 列出、查看、删除和批量删除工作区中的文件。
  • 请求历史: 浏览工作区的请求历史记录。
  • 工作区导出: 导出工作区数据和结构。
  • API组和API管理: 浏览、查看、创建、更新和删除API组和API。

安装步骤

  1. 环境准备: 确保已安装 Python 3.8 或更高版本。
  2. 安装依赖: 打开终端,运行以下命令安装项目依赖:
    pip install httpx "mcp[cli]"

服务器配置

MCP客户端需要配置以下信息以连接到Simple Xano MCP Server。配置信息为JSON格式,示例如下:

{
  "server_name": "xano-mcp-server",
  "command": "python",
  "args": ["xano_mcp_sdk.py", "--token", "<YOUR_XANO_API_TOKEN>"]
}

参数说明:

  • 'server_name': 服务器名称,可以自定义,用于在MCP客户端中标识该服务器。 例如: '"xano-mcp-server"'。
  • 'command': 启动服务器的命令。这里使用 'python' 命令来运行Python脚本。
  • 'args': 启动命令的参数列表。
    • '"xano_mcp_sdk.py"': 指定要运行的Python脚本文件。
    • '"--token"': 指定Xano API Token的参数。
    • '<YOUR_XANO_API_TOKEN>': 请替换为您的 Xano Metadata API Token。 您需要从Xano平台获取有效的API Token,并替换掉 '<YOUR_XANO_API_TOKEN>' 占位符。 请注意,为了安全起见,建议将 'XANO_API_TOKEN' 设置为环境变量,而不是直接在命令行中暴露。 如果设置为环境变量,则可以移除 '--token <YOUR_XANO_API_TOKEN>' 参数。

环境变量配置 (推荐): 您也可以将 Xano API Token 设置为环境变量,避免在命令行中直接暴露 Token。 可以设置环境变量 'XANO_API_TOKEN' 或 'xanoApiToken'。 设置环境变量后,启动服务器的 'args' 可以简化为 '["xano_mcp_sdk.py"]', 对应的JSON配置为:

{
  "server_name": "xano-mcp-server",
  "command": "python",
  "args": ["xano_mcp_sdk.py"]
}

基本使用方法

  1. 启动服务器: 根据上述服务器配置,在安装了依赖的环境中,使用配置好的命令启动 'xano_mcp_sdk.py' 脚本。 服务器成功启动后,将监听来自MCP客户端的请求。
  2. MCP客户端连接: 在您的MCP客户端应用中,配置上述JSON格式的服务器配置信息,连接到Simple Xano MCP Server。
  3. 调用工具: 连接成功后,您可以使用MCP客户端提供的界面或API,调用服务器提供的各种 'xano_' 开头的工具,例如 'xano_list_instances'、'xano_list_tables' 等,与Xano数据库进行交互。 具体的工具和参数请参考代码中的函数定义和文档注释。

信息

分类

数据库与文件