Mcpinstructionserver

🚀 MCP指令服務器（MCPInstructionServer）

MCP指令服務器（MCPInstructionServer）是一個基於TypeScript的模型上下文協議（Model Context Protocol）服務器，它能讓AI助手發現並訪問結構化的Markdown指令，為AI輔助任務提供了標準化的接口和集中式的指令管理方案。

🚀 快速開始

MCPInstructionServer允許像Claude這樣的AI助手通過標準化接口訪問集中式的Markdown指令庫。通過將指令組織為Markdown文件，您可以創建集中的提示知識庫、維護版本化且結構化的指導文檔、讓AI助手按需搜索和檢索特定指令，以及建立一致的AI輔助任務模式。

安裝

# 克隆倉庫
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer

# 安裝依賴項
npm install

# 構建項目
npm run build

啟動服務器

# 指定指令目錄啟動
npm start -- /path/to/instructions

# 或直接使用node
node dist/index.js /path/to/instructions

✨ 主要特性

• 簡單的文件系統存儲：只需目錄中的Markdown文件。
• 遞歸目錄掃描：通過層次結構組織指令。
• 路徑安全：防止目錄遍歷和訪問允許目錄之外的文件。
• 自動摘要提取：從每個文檔中提取H1標題和第一段。
• 模型上下文協議支持：與實現MCP的AI助手兼容。

📦 安裝指南

先決條件

• Node.js 18+（用於ESM支持）。
• npm或yarn。
• 對TypeScript和Markdown的基本熟悉。

安裝步驟

# 克隆倉庫
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer

# 安裝依賴項
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

啟動服務器

# 指定指令目錄啟動
npm start -- /path/to/instructions

# 或直接使用node
node dist/index.js /path/to/instructions

創建指令

指令是簡單的Markdown文件，擴展名為.md。每個文件應遵循以下結構：

# 指令標題

該指令目的的簡要描述。此第一段將用作列表中指令的摘要。

## 詳細信息

包含更多詳細信息的其他部分...

## 示例

使用示例、代碼片段等。

目錄結構示例

instructions/
├── api/
│   ├── authentication.md
│   └── rate-limiting.md
├── design/
│   ├── color-system.md
│   └── typography.md
└── general/
    ├── code-review.md
    └── git-workflow.md

高級用法

訪問指令

服務器提供兩個MCP工具：

1. listInstructions

返回所有可用指令的列表及其ID和摘要。 示例響應：

id: api/authentication
summary: 身份驗證API - 本文件概述了我們在系統中使用的身份驗證協議。

id: design/typography
summary: 字體指南 - 本指南解釋了我們的字體比例和使用規則。

2. readInstruction

接受一個指令ID並返回對應指令的完整內容。 示例請求：{ "id": "api/authentication" }

📚 詳細文檔

工作原理

服務器索引指定目錄（及其子目錄）中的Markdown文件，將每個文件視為指令文檔。服務器提取每個文檔的標題和第一段以生成可搜索的摘要。

AI助手可以執行以下操作：

1. 列出所有可用指令及其摘要。
2. 請求特定指令的ID。

🔧 技術細節

安全注意事項

• 服務器驗證所有路徑以防止目錄遍歷攻擊。
• 只能訪問指定指令目錄中的文件。
• 沒有寫入功能，僅允許讀取。

📄 許可證

本項目採用MIT許可證。

貢獻

歡迎貢獻！請隨意提交Pull Request。