项目简介

VoltAgent是一个开源的TypeScript AI代理框架，它提供了一整套工具来构建和编排AI代理，包括内存、工作流、工具以及内置的LLM可观测性。

'@voltagent/mcp-docs-server' 是VoltAgent框架的一个特定模块，它实现了一个Model Context Protocol (MCP) 服务器。这个服务器的职责是将VoltAgent的官方文档、代码示例和变更日志等信息，通过标准化的MCP协议暴露给兼容MCP的LLM客户端（如Claude、Cursor等），使AI助手能够直接访问这些信息，从而更有效地辅助开发者进行编码工作。

主要功能点

上下文提供: 将VoltAgent的官方文档、教程和概念指南作为结构化的上下文信息提供给LLM客户端，帮助LLM理解框架的运作方式。
工具集成: 允许LLM客户端通过MCP协议访问和理解VoltAgent中的代码示例和功能，将这些示例作为可调用的“工具”进行学习和利用。
知识管理: 集中管理和发布VoltAgent项目的最新信息，确保LLM客户端总是能够获取到最新、最准确的指引和最佳实践。
标准化通信: 通过JSON-RPC协议与MCP客户端进行通信，确保不同LLM应用和平台的互操作性与兼容性。

安装步骤

创建VoltAgent项目: 在你的终端中运行以下命令，并按照提示完成VoltAgent项目的初始化：
```
npm create voltagent-app@latest
```

安装MCP文档服务器包: 进入新创建的VoltAgent项目根目录，然后使用npm或yarn安装 '@voltagent/mcp-docs-server' 包：

npm install @voltagent/mcp-docs-server
# 或者使用 Yarn
yarn add @voltagent/mcp-docs-server

集成到VoltAgent应用: 打开你的VoltAgent应用的主入口文件（通常是 'src/index.ts'），并导入 'mcpDocsServer'。然后，将其添加到 'new VoltAgent' 构造函数中的 'mcpServers' 配置项里：

import { VoltAgent } from "@voltagent/core";
import { honoServer } from "@voltagent/server-hono";
import { mcpDocsServer } from "@voltagent/mcp-docs-server"; // 导入MCP文档服务器

new VoltAgent({
  // ... 其他 VoltAgent 的 agents, workflows, logger 等配置
  server: honoServer(), // 确保您的应用配置了HTTP服务器
  mcpServers: {
    docs: mcpDocsServer(), // 将 MCP 文档服务器实例添加到名为 'docs' 的键下
  },
});

这里的 'docs' 是你给这个MCP服务器实例定义的名称，LLM客户端在连接时会用到它。

启动服务器: 在项目根目录运行开发命令来启动你的VoltAgent应用：
```
npm run dev
```
服务器成功启动后，你将在终端看到一个包含HTTP服务器地址（例如 'http://localhost:3141'）的输出。此时，MCP文档服务器将作为VoltAgent应用的一个服务运行。

服务器配置（供MCP客户端使用）

为了让外部的MCP客户端（如Cursor、Claude、Windsurf等）能够连接并使用你的VoltAgent MCP文档服务器，你需要为它们提供以下配置信息：

服务器名称 ('name'): 一个人类可读的名称，例如 “VoltAgent Docs”，方便在客户端界面中识别。
命令 ('command'): 用于启动你的VoltAgent应用程序的命令行工具，通常是 'npm' 或 'yarn'。
参数 ('args'): 一个字符串数组，作为 'command' 的参数。常见的参数形式是 '["start", "--", "--mcp-server", "docs"]'。这会指示 'npm' 或 'yarn' 启动你的VoltAgent应用，并确保它暴露名为 'docs' 的MCP服务接口。
URL ('url'): MCP服务器的访问地址。如果你的VoltAgent应用默认运行在 'http://localhost:3141'，并且你在集成时将MCP服务器命名为 'docs'，那么完整的URL通常是 'http://localhost:3141/mcp/docs'。
描述 ('description'): 对此MCP服务器功能的简短说明，例如“访问VoltAgent的官方文档、示例和变更日志”。

基本使用方法

一旦你的VoltAgent MCP文档服务器成功运行并被LLM客户端正确配置，你的LLM助手就可以通过以下方式与其交互：

查询文档内容: 在LLM客户端中直接提问关于VoltAgent框架的任何问题，例如“VoltAgent中如何定义工具？”或“给我一个使用工作流的VoltAgent代码示例。”
获取代码示例: 请求与特定功能或概念相关的代码片段，例如“展示如何在VoltAgent中使用持久化内存的TypeScript代码。”
了解项目更新: 询问“VoltAgent最近有哪些重要更新或新功能？” LLM客户端会利用MCP协议向你的VoltAgent MCP文档服务器发送请求，服务器将返回相关的文档内容或示例，供LLM进一步分析、理解并生成有用的回复或代码建议。

关键词

项目简介

主要功能点

安装步骤

服务器配置（供MCP客户端使用）

基本使用方法

信息