关键词

文档查询上下文服务资源管理工具执行

使用说明

项目简介

Lodestar MCP 是一个基于 Model Context Protocol (MCP) 的服务器示例项目，旨在演示如何构建一个能够响应 LLM 客户端请求的后端服务。该项目提供了一个简单的文档查询工具和一个资源示例，帮助开发者理解 MCP 服务器的基本概念和开发流程。

主要功能点

  • 资源 (Resources): 提供了一个 'echo' 资源，用于演示如何定义和访问简单的资源。
  • 工具 (Tools): 实现了一个 'doc_query' 工具，模拟了文档查询功能。虽然功能是占位符性质的，但展示了工具的基本结构和参数定义。
  • 基于 FastMCP 框架: 使用 'fastmcp' 框架简化了 MCP 服务器的开发，提供了请求处理和路由的基础设施。
  • 可运行的服务器代码: 仓库包含完整的服务器代码 'server.py'，可以直接运行并对外提供服务。

安装步骤

  1. 安装 uv: 如果你的环境中没有 'uv'，需要先安装 'uv' 包管理器。请参考 https://astral.sh/uv 获取安装指南。
  2. 创建虚拟环境: 在仓库根目录下，使用 'uv' 创建虚拟环境： 
    uv venv
  3. 同步依赖: 使用 'uv' 同步项目依赖（虽然此仓库目前没有明确的依赖文件，但为了遵循 README 的指示，执行此步骤）： 
    uv sync

服务器配置

对于 MCP 客户端，你需要配置连接到 Lodestar MCP 服务器的信息。以下是一个 JSON 格式的配置示例，你可以将其添加到 MCP 客户端的服务器配置中：

{
  "serverName": "DocQueryServer",  // 服务器名称，可以自定义
  "command": "mcp",               // 启动服务器的命令，这里使用 mcp 命令行工具
  "args": ["dev", "server.py"]    // 启动命令的参数，指定以开发模式运行 server.py 文件
}

配置信息参数说明:

  • 'serverName': 服务器的名称，客户端用以标识不同的 MCP 服务器。
  • 'command': 启动 MCP 服务器进程的命令。这里假设你已经安装了 'mcp' 命令行工具，并且该工具在系统 PATH 环境变量中。
  • 'args': 传递给 'command' 命令的参数列表。'dev' 参数表示以开发模式启动，'server.py' 指定要运行的服务器代码文件。

基本使用方法

  1. 启动服务器: 在仓库根目录下，打开终端并运行以下命令启动 MCP 服务器：

    mcp dev server.py

    服务器启动后，会监听 MCP 客户端的请求。

  2. 客户端交互: 使用 MCP 客户端（例如，实现了 MCP 协议的 LLM 应用或客户端工具）连接到该服务器。客户端可以发送 JSON-RPC 请求来调用 'doc_query' 工具或访问 'echo' 资源。

示例 - 调用 'doc_query' 工具 (JSON-RPC 请求示例，非直接可执行代码):

{
  "jsonrpc": "2.0",
  "method": "call",
  "params": {
    "tool": "doc_query",
    "arguments": {
      "query": "What is the meaning of life?",
      "api_key": "your-api-key",
      "project_id": "your-project-id"
    }
  },
  "id": 1
}

注意: 'doc_query' 工具和资源的功能目前是占位符性质的，实际的文档查询和数据处理逻辑需要根据具体需求进行完善。此项目主要用于演示 MCP 服务器的基本框架。

信息

分类

AI与计算

访问项目