Document Archive Mcp Server

🚀 MCP 服务器

MCP 服务器使用 Node.js 和 TypeScript 实现，基于 Model Context Protocol (MCP) 开放协议，能标准化应用程序向大型语言模型 (LLM) 提供上下文的方式，实现 AI 应用程序与各种数据源和工具之间的无缝通信。

🚀 快速开始

依赖项

• Node.js 22+ 和 npm

安装

1. 克隆仓库
2. 安装依赖项：

npm install

3. 构建项目：

npm run build

运行服务器

使用 stdio（用于与 MCP 客户端整合）

npm start

使用 SSE（用于 web 用途）

npm start -- --transport=sse

服务器将在默认的 3000 端口上运行。您可以通过设置 PORT 环境变量或使用端口参数更改此值：

npm start -- --transport=sse --port=8080

或：

PORT=8080 npm start -- --transport=sse

✨ 主要特性

• 跨文档搜索工具，用于检索相关信息
• 文档管理，包括文档列表和元数据资源
• 文档 Q&A 提示模板，用于回答有关文档的问题
• 支持 stdio 和 SSE 传输方法
• 全面的日志记录系统
• 环境变量配置
• 路径管理以确保所有服务初始化完成后接受请求
• 平滑关闭处理用于服务器终止

📚 详细文档

系统架构

API

工具

• getDocumentsMetadata：检索可用文档的元数据

  • 参数：
    • query (string)：用户的原始查询或问题

• checkQueryRelevance：评估相关文档并返回 intent 分析的指令

  • 参数：
    • query (string)：用户的原始查询或问题
    • files (Array)：与查询相关联的文件路径列表

• getDocumentMetadata：根据文件路径检索特定文档的元数据

  • 参数：
    • file (string)：文件路径

资源

• /:path：用来处理所有其他路由请求，返回 "default.html"

开发

要以开发模式运行服务器并启用自动重新加载：

npm run dev

对于 SSE 传输在开发模式下：

npm run dev -- --transport=sse

📄 许可证

本项目采用 MIT 许可证。