使用说明

项目简介

本项目 'Courses MCP Example Server' 是一个基于 Spring Boot 构建的示例 MCP 服务器。它演示了如何使用 Spring AI Tooling 框架将现有的服务(这里是课程信息服务)以 “工具 (Tools)” 的形式暴露给遵循 MCP 协议的客户端,例如 LLM 应用。

主要功能点

  • 提供课程数据: 服务器内置了简单的课程数据,包括课程标题和 URL。
  • 暴露课程查询工具: 通过 MCP 协议,客户端可以调用服务器提供的 'find_courses' 和 'find_course_title' 工具来获取课程列表或根据标题查询特定课程。
  • Spring Boot 构建: 使用 Spring Boot 框架快速搭建,易于理解和扩展。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/Ashfaqbs/Model-Context-Protocol.git
    cd Model-Context-Protocol
  2. 进入示例目录:

    cd mcp-servers/custom/courses-mcp-example
  3. 构建项目 (使用 Maven):

    mvn clean install
  4. 运行服务器:

    mvn spring-boot:run

    服务器默认会在 'http://localhost:8080' 启动。

服务器配置

MCP 客户端需要配置服务器的启动信息才能连接和使用本服务器提供的工具。以下是一个示例 JSON 配置,客户端需要根据实际情况进行配置:

{
  "serverName": "courses-mcp-server",
  "command": "java",
  "args": [
    "-jar",
    "path/to/courses-mcp-example-0.0.1-SNAPSHOT.jar"
  ],
  "description": "课程信息 MCP 服务器示例"
}

配置参数说明:

  • 'serverName': 服务器的名称,客户端用于标识连接的服务器,可以自定义。
  • 'command': 启动服务器进程的命令,这里使用 'java' 命令。
  • 'args': 启动命令的参数列表。
    • '"-jar"': 指定运行 JAR 文件。
    • '"path/to/courses-mcp-example-0.0.1-SNAPSHOT.jar"': 请替换为实际的 JAR 文件路径。 该 JAR 文件在执行 'mvn clean install' 后会在 'mcp-servers/custom/courses-mcp-example/target/' 目录下生成。
  • 'description': 服务器的描述信息,方便客户端用户理解服务器用途。

注意: 客户端需要确保能够执行 'java' 命令,并且配置的 JAR 文件路径是正确的。

基本使用方法

  1. 启动服务器: 按照上述安装步骤运行 'Courses MCP Example Server'。
  2. 配置 MCP 客户端: 在 MCP 客户端中,添加上述 JSON 配置,确保配置中的 JAR 文件路径正确指向你构建的项目 JAR 文件。
  3. 连接服务器: 在 MCP 客户端中,连接名为 'courses-mcp-server' 的服务器。
  4. 使用工具: 连接成功后,客户端可以发现并调用服务器提供的 'find_courses' (获取所有课程) 和 'find_course_title' (根据标题查询课程) 工具,从而获取课程信息。具体的工具调用方式请参考 MCP 客户端的使用说明。

信息

分类

AI与计算