MCP文档服务器

EasyPeasyMCP是一个轻量级、零配置的MCP服务器,用于快速为文档项目提供AI可访问性,支持从llms-full.txt文件或OpenAPI/AsyncAPI目录生成和搜索文档内容。

  • by derberg
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 derberg/EasyPeasyMCP

使用说明

EasyPeasyMCP

轻量级、零配置 主控程序 文档项目服务器。

给它一个 llms-full.txt 文件(本地路径或URL)和可选的OpenAPI/AsyncAPI目录。如果你没有它,它还会让你构建一个。它只注册对你提供的内容有意义的MCP工具——没有代码更改,也没有硬编码的路径。

目录

为什么不同

  • 没有RAG,没有矢量数据库,没有嵌入管道。 搜索是一种不区分大小写的行扫描,具有可配置的上下文——所有这些都在进程中,在内存中。对于内容结构良好的小型项目,如 llms-full.txt,这就是你开始所需要的——没有基础设施,没有运营负担,易于在内部推销。整个搜索功能是大约25行香草JS,没有运行时依赖关系。

  • 任何具有 llms-full.txt MCP在30秒内启用。 点 llmsTxt 在托管URL上,您就完成了——没有本地文件同步,没有管道。文档更新,AI自动获取新鲜内容。重要的是采用曲线: llms.txt标准 正在成为文档网站的常态,这个工具使每个网站都可以立即通过人工智能访问。

    没有 llms-full.txt 还没有?没问题——只要你有Markdown文件,捆绑的 easy-peasy-build CLI将根据您的文档和规范为您生成一个。

  • 有条件的工具注册使AI的上下文保持干净。 没有OpenAPI目录?不 list_openapi_specs 工具。工具仅在内容存在时出现——MCP表面与您提供的内容完全匹配。

何时使用此功能,何时不使用

这是一个 速度优先工具。当您需要代理在几分钟内而不是几天内访问新知识时,可以使用它——快速验证概念、个人工作流程、演示或早期内部试点,在这些情况下,快速运行比完美更重要。

对于跨团队共享的专业、长期设置,你最终会想要一个合适的 块→ 嵌入→ RAG 相反,管道。这为您提供了语义搜索(代理会找到 意义,而不仅仅是匹配单词),每个查询的令牌消耗要低得多,并且能够跨大型或频繁更新的知识库进行扩展,而无需将所有内容加载到内存中。该工具在每次启动时加载全部内容——对于几百KB来说这很好,但这是一个上限,而不是基础。

根本没有文件?甚至连Markdown文件都没有?如果你真的很着急,只需让代理抓取你所依赖的开发人员门户——它可以抓取相关页面并将内容整合在一起。它甚至可以检查OpenAPI或AsyncAPI规范的常见位置,并获取这些位置。将其与 easy-peasy-build 几分钟内,您就可以拥有一个可用的MCP服务器,无需维护任何本地文件。

诚实的总结:用这个来验证人工智能辅助文档是否值得投资。一旦值得,就可以升级到适当的RAG堆栈。

运作原理

您提供的内容 已注册的工具
llms-full.txt get_full_documentation, search_documentation
OpenAPI目录 list_openapi_specs, get_openapi_spec
AsyncAPI目录 list_asyncapi_specs, get_asyncapi_spec

search_documentation 涵盖所有加载的内容(llms-full.txt+所有规范)。

快速开始

Option A — Config file Option B — CLI args

放下 .easypeasymcp.json (或 .easypeasymcp.yaml)在您的文档项目根目录中:

JSON:

{
  "name": "my-project",
  "llmsTxt": "./llms-full.txt",
  "openapi": "./openapi",
  "asyncapi": "./asyncapi",
  "build": {
    "docs": ["./guides", "./api-reference"]
  }
}

YAML:

name: my-project
llmsTxt: ./llms-full.txt
openapi: ./openapi
asyncapi: ./asyncapi
build:
  docs:
    - ./guides
    - ./api-reference

路径是相对于配置文件的。忽略任何你没有的钥匙。 llmsTxt 也可以是URL build 部分是可选的——如果希望服务器重新生成,请将其包含在内 llms-full.txt 每次启动时(添加 --rebuild 到下面的命令)。

注册需要配置文件的绝对路径 (配置中的路径是相对于它的):

# Use absolute path
claude mcp add my-project npx easy-peasy-mcp@0.0.11 \
  -- --rebuild --config /absolute/path/to/.easypeasymcp.json

# Or convert relative to absolute with shell expansion
claude mcp add my-project npx easy-peasy-mcp@0.0.11 \
  -- --rebuild --config $(pwd)/.easypeasymcp.json

不需要配置文件——直接传递所有内容。也适用于URL:

claude mcp add asyncapi npx easy-peasy-mcp@0.0.11 -- \
  --name "asyncapi" \
  --llms https://raw.githubusercontent.com/derberg/EasyPeasyMCP/refs/heads/main/example-llms/asyncapi.txt

正在生成llms-full.txt

Option A — gitingest.com Option B — easy-peasy-build

gitingest.com 从任何公共仓库或网站生成单个组合文本文件。当您不需要文件与更新保持同步时,这非常适合一次性抓取。

对于本地Markdown文件+OpenAPI/AsyncAPI规范:

npx --package=easy-peasy-mcp@0.0.11 easy-peasy-build \
  --docs ./guides \
  --docs ./api-reference \
  --openapi ./openapi \
  --asyncapi ./asyncapi \
  --output ./llms-full.txt
  • --docs 对于多个源目录是可重复的
  • 读取 .md 和 .mdx 按名称递归排序的文件
  • OpenAPI/AsyncAPI文件作为代码围栏块包含在内
  • 省略 --output 打印到stdout

保留 llms-full.txt 自动刷新,添加 build 部分到 .easypeasymcp.json 并通过 --rebuild 注册MCP服务器时,它将在每次启动时重新生成,而不需要手动运行。

配置参考

easy-peasy-mcp (MCP服务器)

CLI标志 配置键 说明
--config <path> -- 路径 .easypeasymcp.json.Config文件键用作默认值;CLI标志会覆盖它们。
--name <string> name 服务器名称,显示在MCP客户端中,并嵌入在工具描述中。默认为 "docs".
--llms <path|url> llmsTxt 路径或URL llms-full.txt.登记簿 get_full_documentation 和 search_documentation.
--openapi <dir> openapi OpenAPI规范(JSON/YAML)目录的路径。寄存器 list_openapi_specs 和 get_openapi_spec.
--asyncapi <dir> asyncapi AsyncAPI规范(JSON/YAML)目录的路径。寄存器 list_asyncapi_specs 和 get_asyncapi_spec.
--rebuild build 重建 llms-full.txt 从每家初创公司的当地消息来源。需要一个配置文件,其中包含 build 部分(见下文)。
--debug -- 启用stderr的调试日志记录。可用于排除搜索问题或验证内容是否正确加载。

配置文件路径是相对于配置文件的位置解析的。至少一个 --llms, --openapi,或 --asyncapi 是必需的。

build 配置节

可选。如果存在,请添加 --rebuild 到 claude mcp add 命令,服务器将重新生成 llms-full.txt 在每一家初创公司。

{
  "name": "my-project",
  "llmsTxt": "./llms-full.txt",
  "openapi": "./openapi",
  "build": {
    "docs": ["./guides", "./api-reference"],
    "title": "My Project"
  }
}

openapi 和 asyncapi 从顶层开始自动重用。 llmsTxt 是输出路径。

easy-peasy-build (llms-full.txt生成器)

CLI标志 说明
--docs <dir> Markdown源目录。可重复用于多个目录。
--openapi <dir> OpenAPI规范目录。作为代码围栏块包含的文件。
--asyncapi <dir> AsyncAPI规范目录。作为代码围栏块包含的文件。
--title <string> 生成的文件头的项目标题。
--output <path> 输出文件路径。省略打印到stdout。

本地调试

使用 MCP检查员 以交互方式测试服务器:

With config file With CLI args
npx @modelcontextprotocol/inspector@0.21.1 \
  npx easy-peasy-mcp@0.0.11 -- \
  --config /path/to/.easypeasymcp.json
npx @modelcontextprotocol/inspector@0.21.1 \
  npx easy-peasy-mcp@0.0.11 -- \
  --llms /path/to/llms-full.txt \
  --openapi /path/to/openapi

要在没有任何本地文件的情况下立即尝试:

npx @modelcontextprotocol/inspector@0.21.1 \
  npx easy-peasy-mcp@0.0.11 -- \
  --llms https://raw.githubusercontent.com/derberg/EasyPeasyMCP/refs/heads/main/example-llms/asyncapi.txt

提示: 添加 --debug 查看有关内容加载和搜索操作的详细日志记录:

npx @modelcontextprotocol/inspector@0.21.1 \
  npx easy-peasy-mcp@0.0.11 -- \
  --config /path/to/.easypeasymcp.json \
  --debug

调试日志显示在 服务器通知 MCP检查器UI中的视图。