使用说明
项目简介
LLMling Server (mcp-server-llmling) 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 应用提供标准化的上下文信息和功能服务。它通过 YAML 配置文件来定义和管理 LLM 应用所需的环境,无需编写代码即可快速搭建 MCP 服务器。
主要功能点
- 资源管理: 支持多种类型的资源 (Resources) 定义和加载,包括文本文件、纯文本内容、命令行输出、Python 源码、Python 函数调用结果和图片等。资源可配置热重载和处理管道,并支持 URI 访问。
- 工具系统: 允许注册和执行 Python 函数作为 LLM 可调用的工具 (Tools),支持 OpenAPI 规范的工具集,具备工具参数验证和结构化响应能力。
- Prompt 管理: 支持静态和动态 Prompt 模板 (Prompts) 定义,包括文件 Prompt 和 Python 函数 Prompt,支持 Prompt 参数验证和补全建议。
- 多传输协议: 支持 Stdio (标准输入输出) 和 SSE (Server-Sent Events) 等多种传输协议,方便与不同类型的 MCP 客户端集成。
- 动态配置注入: 通过 HTTP API 和 WebSocket 接口,支持在服务器运行时动态注入和更新配置,无需重启服务器即可应用新的资源、工具或 Prompt。
- Zed 编辑器兼容模式: 特别为 Zed 编辑器优化,能够处理 Zed 编辑器特有的 Prompt 参数输入格式。
安装步骤
- 环境准备: 确保已安装 Python 环境 (建议 Python 3.8 或更高版本)。
- 安装 LLMling Server: 使用 'uvx' (建议) 或 'pip' 安装 'mcp-server-llmling' 包。
或uvx add mcp-server-llmlingpip install mcp-server-llmling
服务器配置
LLMling Server 通过 YAML 配置文件进行配置。以下是配置 Claude Desktop 客户端连接 LLMling Server 的 'claude_desktop_config.json' 示例:
{ "mcpServers": { "llmling": { "command": "uvx", "args": [ "mcp-server-llmling", "start", "path/to/your/config.yml" // 替换为你的 YAML 配置文件路径 ], "env": {}, "name": "llmling" // MCP server name,客户端用此名称标识服务器 } } }
配置参数说明:
- 'command': 启动 LLMling Server 的命令,这里使用 'uvx mcp-server-llmling' 启动最新版本。
- 'args': 传递给启动命令的参数,'start' 子命令用于启动服务器,'path/to/your/config.yml' 指定 YAML 配置文件的路径。
- 'env': 运行环境环境变量,默认为空。
- 'name': MCP 服务器的名称,客户端通过此名称来识别和连接服务器,需与配置文件的 'server_name' 一致。
基本使用方法
- 创建 YAML 配置文件: 根据你的 LLM 应用需求,创建 YAML 配置文件 ('config.yml'),定义资源 (resources)、工具 (tools) 和 Prompt (prompts)。具体配置格式请参考仓库文档或 README 中的 Server Configuration 章节。
- 启动 LLMling Server: 使用以下命令启动服务器,并指定你的 YAML 配置文件路径。
uvx mcp-server-llmling start path/to/your/config.yml - 配置 MCP 客户端: 在 MCP 客户端 (如 Zed 编辑器或 Claude Desktop) 中,配置连接到 LLMling Server。根据客户端的要求,填写服务器启动命令、参数和服务器名称等信息。
- 在客户端中使用: 客户端连接成功后,即可利用 LLMling Server 提供的资源、工具和 Prompt 进行 LLM 应用开发和交互。
信息
分类
AI与计算