文档服务工具

一个为with-custom-cursor库提供的文档服务器,支持获取README、项目文件、文件内容、文档搜索和Medium文章教程。

  • by AndreQuintero
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 andrequintero/mcp-documentation-repo

使用说明

使用自定义游标文档服务器

该项目为 使用自定义光标 图书馆。它公开了端点以获取README、项目文件、文件内容、文档搜索和库的Medium文章教程。

特性

  • 从GitHub存储库获取最新的README
  • 列出存储库中的所有文件
  • 检索存储库中任何文件的内容
  • 搜索文档和标记文件
  • 获取Medium文章教程并将其转换为markdown
  • 将所有文档汇总到一个响应中

用法

此服务器旨在作为Node.js进程运行。它使用模型上下文协议(MCP)进行通信,旨在与支持MCP服务器的工具集成。

需求

  • Node.js(建议使用v14或更高版本)
  • 从GitHub和Medium获取数据的互联网访问

环境变量

  • GITHUB_TOKEN (可选):用于提高速率限制的GitHub API令牌
  • MEDIUM_ARTICLE_URL (可选):覆盖默认的媒体文章URL

运行服务器

npm install
npm start

服务器将启动并通过stdio监听MCP请求。

端点/工具

  • get_adme:从存储库中获取README文件
  • get_project_files:列出存储库中的所有文件
  • 获取_文件_内容:获取特定文件的内容
  • search_docs:搜索markdown文档文件
  • 获取_日志_文章:获取并转换Medium教程文章
  • get_all_文档:聚合README、Medium文章和关键文件

项目结构

  • index.js:主服务器实现

参考文献

许可证

麻省理工学院