MCPInstructionServer
2025.03.16
0
JavaScript指令库知识管理开发效率
MCPInstructionServer 是一个基于 TypeScript 的 MCP（Model Context Protocol）服务器，旨在为 AI 助手提供结构化的 Markdown 指令库访问能力。它通过标准化接口，使 AI 助手能够发现和访问组织良好的 Markdown 指令，从而创建集中化的知识库，维护版本化的指导文档，并允许 AI 助手按需搜索和检索特定指令。
View on GitHub
Overview
基本能力
产品定位
MCPInstructionServer 是一个为 AI 助手设计的指令库服务器，通过 MCP 协议提供结构化的 Markdown 指令访问服务。
核心功能
- 简单基于文件系统的存储：仅需 Markdown 文件和目录即可组织指令。
- 递归目录扫描：支持层次化的文件夹结构来组织指令。
- 路径安全：防止目录遍历和访问指定目录外的文件。
- 自动摘要提取：从每个文档中提取 H1 标题和第一段作为摘要。
- MCP 协议支持：兼容实现 MCP 的 AI 助手。
适用场景
- 创建和维护 AI 助手的集中化知识库。
- 提供版本化和结构化的指导文档。
- 实现 AI 助手按需搜索和检索指令的功能。
- 建立 AI 辅助任务的一致模式。
工具列表
- listInstructions：列出所有可用指令及其 ID 和摘要。
- readInstruction：根据指令 ID 返回对应指令的完整内容。
常见问题解答
- 安全性：服务器验证所有路径以防止目录遍历攻击，仅允许访问指定指令目录内的文件，且仅提供读取能力。
使用教程
使用依赖
- Node.js 18+（支持 ESM）
- npm 或 yarn
- 基本熟悉 TypeScript 和 Markdown
安装教程
# 克隆仓库
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer
# 安装依赖
npm install
# 构建项目
npm run build
调试方式
# 开发模式运行（自动重启）
npm run dev -- /path/to/instructions
# 运行测试
npm test
启动服务器
# 使用指令目录路径启动服务器
npm start -- /path/to/instructions
# 或直接使用 node
node dist/index.js /path/to/instructions
创建指令
指令为简单的 Markdown 文件，扩展名为 .md。每个文件应遵循以下结构：
# 指令标题
简要描述此指令的目的。第一段将用作列出指令时的摘要。
## 详细信息
更多详细信息的附加部分...
## 示例
使用示例、代码示例等。