Document Archive MCP Server

🚀 MCP 服务器

MCP 服务器是一个基于 Node.js 和 TypeScript 实现的应用，借助 Model Context Protocol (MCP) 开放协议，能让 AI 应用程序与各类数据源和工具实现无缝通信，为应用向大型语言模型 (LLM) 提供标准化的上下文交互方案。

🚀 快速开始

依赖项

本项目依赖于 Node.js 22+ 和 npm，请确保你的环境中已安装这些工具。

安装

按照以下步骤完成项目的安装：

1. 克隆项目仓库：

git clone [项目仓库地址]

2. 安装项目依赖：

npm install

3. 构建项目：

npm run build

运行服务器

基础用法

使用 stdio 方式运行服务器，适用于与 MCP 客户端整合：

npm start

高级用法

使用 SSE 方式运行服务器，适用于 Web 应用场景：

npm start -- --transport=sse

服务器默认运行在 3000 端口，你可以通过以下两种方式修改端口：

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

或者设置环境变量：

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

✨ 主要特性

本服务器实现了一系列实用功能，具体如下：

• 跨文档搜索：提供强大的跨文档搜索工具，可快速检索相关信息。
• 文档管理：支持文档列表展示和元数据资源管理。
• 文档问答：提供文档 Q&A 提示模板，方便回答有关文档的问题。
• 传输方式：支持 stdio 和 SSE 两种传输方法。
• 日志系统：具备全面的日志记录系统，便于问题排查和监控。
• 环境配置：支持通过环境变量进行配置。
• 路径管理：确保所有服务初始化完成后才接受请求。
• 平滑关闭：提供平滑关闭处理机制，用于服务器终止。

📦 安装指南

依赖项

• Node.js 22+ 和 npm

安装步骤

1. 克隆项目仓库：

git clone [项目仓库地址]

2. 安装依赖：

npm install

3. 构建项目：

npm run build

💻 使用示例

基础用法

使用 stdio 方式运行服务器：

npm start

高级用法

使用 SSE 方式运行服务器，并指定端口：

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

📚 详细文档

API 文档

工具类 API

• getDocumentsMetadata：用于检索可用文档的元数据。
  • 参数：
    • query (string)：用户的原始查询或问题。
• checkQueryRelevance：评估相关文档并返回 intent 分析的指令。
  • 参数：
    • query (string)：用户的原始查询或问题。
    • files (Array)：与查询相关联的文件路径列表。
• getDocumentMetadata：根据文件路径检索特定文档的元数据。
  • 参数：
    • file (string)：文件路径。

资源类 API

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

🔧 技术细节

系统架构

本项目的系统架构图如下：

开发模式

若你需要在开发模式下运行服务器并启用自动重新加载功能，可使用以下命令：

npm run dev

若要在开发模式下使用 SSE 传输方式，可使用以下命令：

npm run dev -- --transport=sse

📄 许可证

本项目采用 MIT 许可证。