使用说明(Markdown 格式)

  • 项目简介

    • 该仓库实现了一个基于 MCP 的服务器端,使用 Vercel 的 MCP 适配器来注册并暴露工具,客户端通过 MCP 协议调用这些工具获取文档相关信息。
  • 主要功能点

    • MCP 服务端实现:通过 /api/mcp 路径提供 MCP JSON-RPC 服务,注册并暴露工具供客户端调用。
    • 工具注册与执行:当前实现了三个工具:
      • searchLangfuseDocs:对 Langfuse 文档进行语义检索(RAG)。
      • getLangfuseDocsPage:获取指定页面的原始 Markdown 内容。
      • getLangfuseOverview:返回 llms.txt 的概览信息。
    • 与文档站点的集成:工具调用会对 Langfuse 文档进行检索、获取页面内容等,便于在 LLM 对话中提供上下文与引用。
    • 与前端/SDK 的协同:示例中与 Langfuse Docs 的前端组件和客户端 SDK 配合使用,展示了 MCP 客户端如何发现并调用服务器端工具。
  • 安装步骤

    • 安装依赖并启动本地开发服务器(文档站点开发指南)
      • 使用 Node.js 环境,运行项目自带的启动命令(例如 pnpm dev)来启动 Next.js 应用并监听在本地端口(通常为 3333,参见 README 的本地开发说明)。
    • 服务器在本地启动后,可通过 /api/mcp 访问 MCP 服务。
  • 服务器配置(MCP 客户端需要此信息以连接 MCP 服务器;以下为文本形式的 JSON 配置示例) JSON 配置示例(文本形式) { "serverName": "Langfuse Docs MCP Server", "command": "pnpm", "args": ["dev"], "host": "localhost", "port": 3333, "description": "Next.js 基于 vercel/mcp-adapter 的 MCP 服务器,用于 Langfuse 文档站点的工具暴露与调用。" } 注释说明:

    • serverName:MCP 服务器的名称,便于标识。
    • command/args:用于启动 MCP 服务器进程的命令及参数。仓库提供的启动方式为本地开发模式(pnpm dev),生产部署时请按实际环境替换为适合的启动命令。
    • host/port:服务器监听地址与端口。文档站点在本地开发时通常使用 3333 端口,请在客户端连接时保持一致。
    • description:对 MCP 服务器的简要描述,方便运维与文档查看。
  • 基本使用方法

    • 启动服务器:按照本地开发指南启动文档站点服务器,使 /api/mcp 路径可用。
    • 客户端连接与调用:
      • 客户端通过 MCP 协议连接到服务器的 /api/mcp 路径,发现并调用注册的工具。
      • 调用过程会返回 JSON-RPC 风格的响应,包含工具执行结果和可能的元数据。
    • 现有工具用法概览:
      • searchLangfuseDocs:对 Langfuse 文档进行语义检索,获取相关段落或答案。
      • getLangfuseDocsPage:获取指定页面的原始 Markdown 内容,用于上下文渲染或审阅。
      • getLangfuseOverview:获取 llms.txt 的概要信息,便于快速了解可用端点与概览。
  • 额外信息

    • MCP 服务器端口、路由及工具注册等实现细节已在代码中体现,若要扩展工具,可以在 /api/mcp 的服务器端注册新的 tool。
    • 服务器与客户端之间通过 JSON-RPC 进行通信,服务端负责会话与能力声明等能力框架的实现。

信息

分类

网页与API