使用说明

项目名称: MCP Firebird

项目简介: MCP Firebird 是一个实现了 Anthropic Model Context Protocol (MCP) 的服务器,专门为 Firebird 数据库设计。它使得大型语言模型 (LLMs) 能够以安全和受控的方式访问、分析和操作 Firebird 数据库中的数据,为 LLM 应用提供强大的数据上下文支持。

主要功能点:

  • 数据库连接与管理:支持连接到 Firebird 数据库,并提供数据库信息查询功能。
  • 元数据访问:提供数据库表的结构信息(如表名、列名、数据类型、字段描述、主键、外键等)查询能力。
  • SQL 查询执行:允许 LLM 客户端通过工具安全地执行 SQL 查询,并返回查询结果。
  • 预定义 Prompt 模板:内置多种 Prompt 模板,例如数据查询、表结构分析、SQL 优化和 SQL 生成等,方便 LLM 进行自然语言交互,简化复杂数据库操作。

安装步骤:

  1. 前提条件:确保您的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 全局安装 (推荐):打开终端或命令提示符,运行命令 'npm install -g mcp-firebird' 将 MCP Firebird 服务器全局安装到您的系统中。
  3. 项目安装:或者,您也可以在您的项目目录下运行 'npm install mcp-firebird' 将其安装为项目依赖。

服务器配置: MCP 服务器需要配置后才能被 MCP 客户端(如 Claude Desktop)调用。以 Claude Desktop 为例,您需要在其配置文件 'claude_desktop_config.json' 中添加 MCP Firebird 服务器的配置信息。以下是一个配置示例,您可以根据您的实际情况修改:

{
  "mcpServers": {
    "mcp-firebird": {  //  服务器名称,您可以自定义,用于在 Claude Desktop 中标识该服务器。
      "command": "npx", //  启动服务器的命令,通常使用 'npx' 来运行本地安装的 Node.js 包。
      "args": [       //  启动命令的参数列表,用于配置 MCP Firebird 服务器。
        "mcp-firebird", //  指定要执行的命令为 'mcp-firebird',即 MCP Firebird 服务器的入口。
        "--database",   //  指定数据库文件路径的参数。
        "/path/to/your/database.fdb", //  请替换为您的 Firebird 数据库文件的**绝对路径**。这是 MCP 服务器连接 Firebird 数据库所必需的参数。
        "--user",       //  指定数据库用户名的参数。
        "SYSDBA",       //  请替换为您的 Firebird 数据库的用户名,默认为 'SYSDBA'。
        "--password",   //  指定数据库密码的参数。
        "masterkey"    //  请替换为您的 Firebird 数据库的密码,默认为 'masterkey'。
      ]
    }
  }
}

注意:

  • 请务必将 '/path/to/your/database.fdb'、'SYSDBA'、'masterkey' 替换为您实际的 Firebird 数据库文件路径、用户名和密码。
  • 配置文件中数据库路径必须使用绝对路径
  • 修改 'claude_desktop_config.json' 文件后,您需要完全重启 Claude Desktop 以使配置生效。

基本使用方法: 成功配置并启动 MCP Firebird 服务器后,MCP 客户端 (如 Claude Desktop) 即可连接到该服务器。您可以通过客户端提供的界面或 API 调用 MCP 服务器提供的功能。

  • 使用工具 (Tools):客户端可以调用服务器预注册的工具,例如:

    • 'list-tables':获取 Firebird 数据库中所有表的列表。
    • 'describe-table':获取指定表的详细结构信息。
    • 'execute-query':执行自定义 SQL 查询并获取结果数据。
    • 'get-field-descriptions': 获取指定表的字段描述信息。
  • 使用 Prompt 模板 (Prompts):客户端可以利用服务器提供的 Prompt 模板,以自然语言驱动 LLM 与 Firebird 数据库进行交互,例如:

    • 'query-data':使用自然语言描述数据查询需求。
    • 'analyze-table':分析数据库表的结构和数据特征。
    • 'optimize-query':优化现有的 SQL 查询语句。
    • 'generate-sql':根据自然语言描述生成 SQL 查询语句。

通过这些工具和 Prompt 模板,LLM 客户端能够便捷、安全地利用 Firebird 数据库中的数据和功能,实现更智能的应用场景。

信息

分类

数据库与文件