MCP 服务器

一个使用 Node.js 和 TypeScript 实现的模型上下文协议 (MCP) 服务器。

什么是 MCP？

模型上下文协议 (MCP) 是一个开放协议，它标准化了应用程序如何向 LLM（大型语言模型）提供上下文。它允许 AI 应用程序与各种数据源和工具之间进行无缝通信。

特性

此服务器实现提供：

• 跨文档搜索工具，用于检索相关信息
• 文档管理，包括文档列表和元数据资源
• 文档问答提示模板，用于回答有关文档的问题
• 支持 stdio 和 SSE 传输方法
• 完善的日志系统
• 通过环境变量进行配置

快速开始

前提条件

• Node.js 18+ 和 npm

安装

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

npm install

3. 构建项目：

npm run build

运行服务器

使用 stdio（用于与 MCP 客户端集成）

npm start

使用 SSE（用于基于 Web 的使用）

npm start -- --transport=sse

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

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

或者：

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

API

工具

• cross_document_search: 跨文档搜索相关信息
  • 参数：
    • query (string): 搜索查询
    • max_results (number, default: 5): 要返回的最大结果数

资源

• documents://list: 获取可用文档列表
• document://{id}: 获取特定文档的元数据

提示

• document_qa: 关于文档内容的问答
  • 参数：
    • document_id (string): 要查询的文档的 ID
    • question (string): 关于文档要提出的问题

配置

服务器可以通过环境变量进行配置：

• SERVER_NAME: 服务器名称（默认值："document-archive-mcp-server"）
• SERVER_VERSION: 服务器版本（默认值："1.0.0"）
• ENABLE_RESOURCES: 启用/禁用资源（默认值：true）
• ENABLE_TOOLS: 启用/禁用工具（默认值：true）
• ENABLE_PROMPTS: 启用/禁用提示（默认值：true）
• PORT: SSE 传输的默认端口（默认值：3000）
• TRANSPORT_TYPE: 默认传输类型（默认值："stdio"）
• LOG_LEVEL: 日志级别（默认值："info"）
• LOG_DIR: 日志文件目录（默认值："logs"）
• LOG_FILE: 主要日志文件名（默认值："combined.log"）
• ERROR_LOG_FILE: 错误日志文件名（默认值："error.log"）
• ENABLE_FILE_LOGGING: 启用文件日志记录（生产环境中默认为 true，开发环境中默认为 false）

开发

要在开发模式下运行服务器并自动重新加载：

npm run dev

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

npm run dev -- --transport=sse

许可证

ISC