关于 Docs To Llm
Docs To Llm 将 URL 中的技术文档处理为精简版和完整版 llm.txt 文件,供大模型作为上下文使用,适用于 Cursor、Windsurf、Cline 或 Roo Code 等工具。
主要功能
- 01处理 URL 中的文档
- 02识别文档导航区块
- 03将相对链接转为绝对链接
- 04移除无关 HTML 元素
- 05按相关性为链接评分
- 06生成精简版和完整版文本
适用场景
- 01将库文档整理为大模型上下文
- 02生成文档标题和链接的简要索引
- 03为编码环境保存完整文档文本
MCP 相关
向 MCP 客户端提供 process_documentation 工具。该工具接收文档 URL、库名称和保存路径,并返回生成文件的位置。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
暂未收录安装方式
我们还没有获取到这个服务的安装包或远程地址,请按项目 README 中的说明安装。
工具
还没有获取到工具列表
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
用于文档处理的 MCP 服务
用于将技术文档处理为 llm.txt 格式的 MCP 服务,可在 Cursor、Windsurf、Cline 或 Roo Code 等环境中用作大模型的上下文。
要求
- Python 3.7+
- uv(推荐)或 pip
下载仓库
使用 MCP 服务前,需要从 GitHub 克隆仓库:
git clone https://github.com/Rybens92/docs-to-llm.txt_generator /your/chosen/directory
然后更新 mcp_settings.json 配置中的路径:
"args": [
"/your/path/to/this/mcp/server/src/server.py"
]
将 /your/path/to/this/mcp/server 替换为克隆仓库的实际路径。
安装
使用 uv(推荐):
uv pip install -r requirements.txt
或使用 pip:
pip install -r requirements.txt
=======
运行
开发模式(推荐用于测试)
fastmcp dev src/server.py
在 Claude Desktop 中安装
fastmcp install src/server.py
直接执行
python src/server.py
在 Roo Code 或 Cline 中使用
mcp_settings.json 配置
将以下配置添加到 Roo Code 或 Cline 中的 mcp_settings.json:
{
"mcpServers": {
"docs-to-llm": {
"command": "python",
"args": [
"/your/path/to/this/mcp/server/src/server.py"
],
"disabled": false
}
}
}
请记得将 "/your/path/to/this/mcp/server" 替换为项目目录的实际路径。
使用示例
配置完成后,可以这样使用该服务:
<use_mcp_tool>
<server_name>docs-to-llm</server_name>
<tool_name>process_documentation</tool_name>
<arguments>
{
"url": "https://example.com/docs",
"library_name": "example_lib",
"txt_save_path": "/path/to/save/directory"
}
</arguments>
</use_mcp_tool>
该服务将生成两个文件:
llm_{library_name}_short.txt- 仅包含文档标题和链接llm_{library_name}_full.txt- 包含完整的文档内容
可用工具
process_documentation
处理指定 URL 中的文档。
参数:
url(字符串)- 文档页面的 URLlibrary_name(字符串)- 库的名称(用于输出文件名)txt_save_path(字符串)- 输出文件的保存路径
返回值:
success(布尔值)- 操作状态message(字符串)- 结果信息files(对象)- 生成文件的路径,键为 "short" 和 "full"
功能
- 自动检测文档导航部分
- 将相对 URL 转换为绝对 URL
- 移除不必要的 HTML 元素(脚本、样式、菜单)
- 处理过程中报告进度
- 详细记录错误
- 使用智能评分系统查找相关文档链接
- 自动检测失败时启用回退机制
- 根据库名称生成经过清理的文件名
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。