使用说明

项目简介

本项目 'mcp-tool-kit' 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型 (LLM) 应用提供上下文信息和功能扩展。它通过集成 SQL Server 和 Jira 等常用工具，使得 LLM 能够安全、可扩展地访问数据库和项目管理系统，从而增强 LLM 在特定领域的应用能力。

主要功能点

SQL Server 工具集成:
- 'sql_execute_query': 执行 SQL 查询并返回结果。
- 'sql_get_tables': 获取数据库中所有表的列表。
- 'sql_get_table_schema': 获取指定表的结构信息。
- 'sql_get_schemas': 获取数据库中所有 schema 的列表。
Jira 工具集成:
- 'jira_get_issue': 根据 issue key 获取 Jira issue 详情。
- 'jira_create_issue': 在 Jira 中创建新的 issue。
- 'jira_search_issues': 使用 JQL 查询 Jira issues。
- 'jira_add_comment': 为 Jira issue 添加评论。
- 'jira_transition_issue': 变更 Jira issue 的状态。

安装步骤

环境准备: 确保已安装 Go 1.18 或更高版本，以及 Docker (如果需要使用 SQL Server 工具)。
配置环境变量:
- 复制仓库根目录下的 '.env.example' 文件并重命名为 '.env'，根据需要修改以下环境变量：
  - SQL Server 配置 (如果需要使用 SQL Server 工具):
    - 'SQL_SERVER': SQL Server 主机名或地址 (默认为 'localhost')
    - 'SQL_PORT': SQL Server 端口 (默认为 '1433')
    - 'SQL_USER': SQL Server 用户名 (默认为 'sa')
    - 'SQL_PASSWORD': SQL Server 密码 (默认为 'StrongPassword123!')
    - 'SQL_DATABASE': SQL Server 数据库名 (默认为 'master')
  - Jira 配置 (如果需要使用 Jira 工具):
    - 'JIRA_USERNAME': Jira 用户名
    - 'JIRA_TOKEN': Jira API token (或密码)
    - 'JIRA_URL': Jira 实例 URL
  - 工具配置:
    - 'CONFIG_TOOLS': 指定要启用的工具，多个工具用逗号分隔，例如 'sql-server,jira'。如果只使用 SQL Server 工具，设置为 'sql-server'；如果只使用 Jira 工具，设置为 'jira'；如果都使用，设置为 'sql-server,jira'。
  - 服务器端口配置:
    - 'PORT': 服务器监听端口 (默认为 '8080')
启动 SQL Server (如果需要使用 SQL Server 工具):
- 确保 Docker 已经运行。
- 首次运行可能需要先构建 SQL Server Docker 镜像 (仓库中未提供 Dockerfile，可能需要自行查找或配置)。
运行 MCP 服务器:
- 在仓库根目录下，执行 './run.sh' 脚本。
- 或者直接使用 'go run cmd/server/main.go' 命令运行。

服务器配置 (MCP 客户端配置)

MCP 客户端需要配置以下信息以连接到此 MCP 服务器。以下是一个 JSON 格式的配置示例，请根据实际情况调整 'command' 和 'args' 字段。

{
  "servers": [
    {
      "name": "mcp-tool-kit-server",
      "command": "./run.sh",
      "args": [],
      "transport": "sse",
      "url": "http://localhost:8080/events"
    }
  ]
}

配置参数说明:

'name': 服务器名称，可以自定义，用于在客户端中标识服务器。
'command': 启动 MCP 服务器的命令。这里假设您在仓库根目录下运行 './run.sh' 脚本。如果直接使用 'go run' 命令，则需要修改为 'go run cmd/server/main.go'。
'args': 启动命令的参数，本例中 'run.sh' 脚本无需参数，所以为空数组 '[]'。
'transport': 传输协议，本项目支持 SSE (Server-Sent Events)，配置为 '"sse"'。
'url': SSE 协议的连接 URL，默认为 'http://localhost:8080/events'，请根据实际服务器地址和端口进行修改。

注意: 请确保 MCP 客户端能够访问到运行 MCP 服务器的网络环境。

基本使用方法

启动 MCP 服务器。
配置并启动 MCP 客户端，连接到已运行的 MCP 服务器。
在 MCP 客户端中，可以使用注册的工具，例如：
- 使用 'sql_execute_query' 工具执行 SQL 查询。
- 使用 'jira_get_issue' 工具获取 Jira issue 信息。
- 具体工具的使用方法请参考 MCP 客户端的文档。

状态检查

访问 'http://localhost:8080/status' 可以查看服务器状态和已加载的工具信息。
访问 'http://localhost:8080/ping' 可以进行连通性测试。

关键词