Slice.js文档MCP
一个MCP(模型上下文协议)服务器,提供从官方GitHub存储库访问Slice.js文档的权限。该服务器允许AI助手和工具无缝查询、搜索和检索文档。
特性
- 动态文档发现:自动发现并索引GitHub仓库中的所有文档文件
- 智能高速缓存:无限的会话缓存,最大限度地减少API请求并提高性能
- 全文检索:使用关键字匹配在所有文档中搜索
- 内容检索:获取特定的文档页面或完整的文档包
- 延迟初始化:文档结构在首次需要时按需加载
安装
全局安装(推荐)
npm install -g slicejs-mcp使用npx(无需安装)
npx slicejs-mcp用法
MCP服务器作为基于stdio的服务运行,非常适合与AI助手和MCP兼容工具集成。
基本用法
npx slicejs-mcp与MCP客户端集成
此服务器旨在与MCP兼容的客户端配合使用。启动时,它公开了4个工具:
工具
1. list_docs
返回所有可用文档部分和类别的列表。
参数: 无
答复: 包含id、标题和路径的文档项的JSON数组。
例子:
[
{
"id": "getting-started",
"title": "Getting Started",
"path": "markdown/getting-started.md"
}
]2. search_docs
使用关键字或短语搜索所有文档。
参数:
query(字符串,必填):搜索词max_results(number,可选,默认值:5):最大结果数
答复: 包含代码段和元数据的JSON搜索结果数组。
3. get_doc_content
获取特定文档页面的完整内容。
参数:
doc_id(string或string\[\],必填):要获取的文档IDinclude_metadata(布尔值,可选,默认值:false):包含其他元数据
答复: 包含文档内容、标题和可选元数据的JSON对象。
4. get_llm_full_context
获取完整的文档包(约2000行),以获取全面的LLM上下文。
参数: 无
答复: 完整的文档文本
注: 这消耗了相当多的令牌,但在一个请求中提供了所有文档。
例子
列出所有文件
// Via MCP client
await callTool("list_docs", {});搜索路线信息
await callTool("search_docs", {
query: "routing",
max_results: 3
});获取特定文档
await callTool("get_doc_content", {
doc_id: "getting-started/routing"
});获取完整的文档上下文
await callTool("get_llm_full_context", {});建筑
- 来源:文件取自https://github.com/VKneider/slicejs_docs
- 缓存:无限会话缓存可防止冗余的API调用
- 初始化:首次使用工具时延迟加载文档结构
- 速率限制:优化以保持在GitHub API限制范围内(60请求/小时)
发展
先决条件
- Node.js>=18
- npm或纱线
设置
git clone
cd slicejs-mcp
npm install
npm run build本地运行
npm start
# or
node dist/index.jsMCP检验员测试
npx @modelcontextprotocol/inspector node dist/index.js贡献
欢迎投稿!请确保:
- 所有工具都保持向后兼容性
- 缓存行为得以保留
- 错误处理是稳健的
许可证
麻省理工学院
