关键词

JDBC文件系统JavaFXKubernetes工具扩展

使用说明

项目简介

Quarkus MCP Servers 是一个基于 Quarkus 框架实现的 Model Context Protocol (MCP) 服务器集合。该项目旨在帮助开发者快速构建和部署 MCP 服务器，以扩展大型语言模型（LLM）应用的功能。它提供了多种预构建的服务器，包括用于访问数据库的 JDBC 服务器、用于访问文件系统的文件系统服务器、用于图形绘制的 JFX 服务器以及用于管理 Kubernetes 集群的 Kubernetes 服务器。

主要功能点

  • 资源管理: 通过 JDBC 服务器连接和操作各种关系型数据库，通过文件系统服务器安全地访问和管理本地文件。
  • 工具集成: 提供丰富的工具集，例如：
    • JDBC 服务器: 执行 SQL 查询、管理数据库表结构等。
    • 文件系统服务器: 读取文件内容、列出目录结构、创建目录等。
    • JFX 服务器: 在 JavaFX 画布上进行图形绘制，支持线条、矩形、圆形、文本等多种图形元素。
    • Kubernetes 服务器: 查询 Kubernetes 资源信息、管理 Pod 等。
  • Prompt 模板: 预置 Prompt 模板，例如 JDBC 服务器提供的 ER 图可视化和示例数据生成 Prompt，方便用户快速上手和使用。
  • 多协议支持: 支持 Stdio 标准输入输出流进行通信。

安装步骤

  1. 环境准备: 确保已安装 JDK 17 或更高版本，并配置好 Maven 构建环境。
  2. 克隆仓库: 使用 Git 克隆仓库到本地： 
    git clone https://github.com/quarkiverse/quarkus-mcp-servers
  3. 进入项目目录: 切换到项目根目录： 
    cd quarkus-mcp-servers
  4. 编译打包: 使用 Maven 进行编译和打包： 
    mvn clean install

服务器配置

MCP 服务器是为 MCP 客户端设计的后端服务。您需要在 MCP 客户端中配置服务器的启动信息才能连接和使用。以下是不同服务器类型的配置示例 (JSON 格式)，您需要根据实际需求选择并配置相应的服务器。

重要提示: 以下配置中的 'command' 和 'args' 字段是 MCP 客户端连接服务器的关键信息。请根据您的实际环境进行调整。

  • JDBC 服务器配置示例:

    {
  "server name": "jdbc",
  "command": "jbang",
  "args": [
    "-q",
    "jdbc@quarkiverse/quarkus-mcp-servers",
    "jdbc:sqlite:/path/to/your/database.db"  //  请替换为您的 JDBC URL，例如 SQLite 数据库文件路径
  ]
}

    参数说明:

    • 'jdbc:sqlite:/path/to/your/database.db': JDBC 连接 URL。根据您使用的数据库类型 (例如 MySQL, PostgreSQL, Oracle 等) 修改此参数。

  • 文件系统服务器配置示例:

    {
  "server name": "filesystem",
  "command": "jbang",
  "args": [
    "-q",
    "filesystem@quarkiverse/quarkus-mcp-servers",
    "/path/to/allowed/directory1",  //  请替换为您希望允许 MCP 客户端访问的目录路径，可以配置多个目录
    "/path/to/allowed/directory2"
  ]
}

    参数说明:

    • '/path/to/allowed/directory1', '/path/to/allowed/directory2': 允许 MCP 客户端访问的目录路径。请根据实际需要配置，确保安全性。

  • JFX 服务器配置示例:

    {
  "server name": "jfx",
  "command": "jbang",
  "args": [
    "-q",
    "jfx@quarkiverse/quarkus-mcp-servers"
  ]
}

    参数说明:

    • JFX 服务器无需额外参数。

  • Kubernetes 服务器配置示例:

    {
  "server name": "kubernetes",
  "command": "jbang",
  "args": [
    "-q",
    "kubernetes@quarkiverse/quarkus-mcp-servers"
  ]
}

    参数说明:

    • Kubernetes 服务器无需额外参数，默认连接到当前 Kubernetes 环境。

基本使用方法

  1. 启动服务器: 根据您选择的服务器类型，使用 JBang 命令启动服务器。例如，启动 JDBC 服务器： 
    jbang -q jdbc@quarkiverse/quarkus-mcp-servers jdbc:sqlite:/path/to/your/database.db
  2. 配置 MCP 客户端: 在支持 MCP 协议的 LLM 客户端 (例如 Claude Desktop) 中，按照客户端的指引，添加并配置您启动的 MCP 服务器。您需要提供服务器名称 ('server name')、启动命令 ('command') 和参数 ('args') 等信息。
  3. 使用 MCP 功能: 在 LLM 客户端中，您将可以使用 MCP 服务器提供的工具和 Prompt，例如：
    • 在聊天对话中，调用 JDBC 服务器的 'read_query' 工具执行 SQL 查询，获取数据库信息。
    • 使用文件系统服务器的 'read_file' 工具读取本地文件内容，作为 LLM 的上下文信息。
    • 调用 JFX 服务器的绘图工具，让 LLM 控制画布进行图形绘制。
    • 使用 Kubernetes 服务器查询集群状态或管理 Kubernetes 资源。

请参考各个服务器目录下的 'README.md' 文件，获取更详细的服务器功能和使用说明。

信息

分类

开发者工具

访问项目