关键词

LLM应用上下文服务YAML配置工具集成Prompt管理

使用说明

项目简介

mcp-server-llmling 是一个基于 Model Context Protocol (MCP) 构建的服务器，它使用 YAML 配置文件来定义 LLM 应用的上下文环境。该服务器旨在简化 LLM 应用的后端开发，通过标准化的 MCP 协议，为 LLM 客户端提供资源访问、工具调用和 Prompt 管理等核心功能。用户可以通过 YAML 文件静态声明 LLM 的运行环境，无需编写大量代码即可快速搭建功能完善的 MCP 服务器。

主要功能点

  • 资源管理: 支持多种资源类型，包括文本文件、纯文本内容、命令行输出、Python 源代码、Python 可调用对象结果和图像资源。支持资源热重载和资源处理管道。
  • 工具系统: 允许注册和执行 Python 函数作为 LLM 工具，支持 OpenAPI 工具集成和工具参数验证。
  • Prompt 管理: 支持静态 Prompt 模板和动态 Prompt 函数，支持 Prompt 参数验证和补全建议。
  • 多传输协议: 支持 Stdio、Server-Sent Events (SSE) 等多种传输协议，方便不同类型的客户端连接。
  • 配置热更新: 支持通过 HTTP 接口或 WebSocket 动态更新服务器配置，无需重启服务器即可应用新的资源、工具或 Prompt。
  • Zed 编辑器和 Claude Desktop 集成: 提供与 Zed 编辑器和 Claude Desktop 等 MCP 客户端的集成配置示例。

安装步骤

  1. 确保已安装 Python 环境（建议 Python 3.8+）。
  2. 使用 pip 安装 'mcp-server-llmling' 包： 
    pip install mcp-server-llmling
    或者使用 uvx 安装最新版本： 
    uvx mcp-server-llmling@latest

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能建立连接。以下是 Zed 编辑器和 Claude Desktop 的配置示例，您可以根据您的 MCP 客户端进行相应的配置。

Zed 编辑器配置 (settings.json):

{
  "context_servers": {
    "llmling": {
      "command": {
        "env": {},
        "label": "llmling",
        "path": "uvx",
        "args": [
          "mcp-server-llmling",
          "start",
          "path/to/your/config.yml" // 将 "path/to/your/config.yml" 替换为您的 YAML 配置文件路径
        ]
      },
      "settings": {}
    }
  }
}
  • 'command.path': 指定启动命令，这里使用 'uvx' (您也可以直接使用 'python -m mcp_server_llmling')。
  • 'command.args': 启动参数，包括 'start' 命令和 YAML 配置文件路径。

Claude Desktop 配置 (claude_desktop_config.json):

{
  "mcpServers": {
    "llmling": {
      "command": "uvx",
      "args": [
        "mcp-server-llmling",
        "start",
        "path/to/your/config.yml" // 将 "path/to/your/config.yml" 替换为您的 YAML 配置文件路径
      ],
      "env": {}
    }
  }
}
  • 'command': 指定启动命令，这里使用 'uvx' (您也可以直接使用 'python -m mcp_server_llmling')。
  • 'args': 启动参数，包括 'start' 命令和 YAML 配置文件路径。

手动启动服务器 (命令行):

uvx mcp-server-llmling@latest start path/to/your/config.yml  # 启动服务器并指定 YAML 配置文件路径
  • 'path/to/your/config.yml': 替换为您的 YAML 配置文件路径。

基本使用方法

  1. 创建 YAML 配置文件: 根据您的需求，创建 YAML 配置文件 (例如 'config.yml')，定义资源 (resources)、工具 (tools) 和 Prompt (prompts)。具体配置格式请参考仓库 README 文档中的 "Server Configuration" 章节。
  2. 启动 MCP 服务器: 使用命令行或 MCP 客户端配置启动服务器，指定 YAML 配置文件路径。
  3. 配置 MCP 客户端: 在您的 MCP 客户端 (例如 Zed 编辑器、Claude Desktop) 中配置连接到该 MCP 服务器。
  4. 在 MCP 客户端中使用: 配置完成后，您就可以在 MCP 客户端中使用服务器提供的资源、工具和 Prompt，与 LLM 进行交互。

示例 YAML 配置文件 (config.yml):

resources:
  my_text_resource:
    type: text
    content: "Hello from MCP Server!"
    description: "示例文本资源"

tools:
  example_tool:
    import_path: "llmling.testing.tools.example_tool"
    description: "示例工具"

prompts:
  example_prompt:
    description: "示例 Prompt"
    messages:
      - role: system
        content: "You are a helpful assistant."
      - role: user
        content: "请读取资源 my_text_resource 的内容"

信息

分类

AI与计算

访问项目