MCPInstructionServer

MCPInstructionServer

AI アシスタントが構造化された Markdown の手順を見つけて利用できるようにする、TypeScript 製の MCP（Model Context Protocol）サーバーです。

概要

MCPInstructionServer を使用すると、Claude などの AI アシスタントは、標準化されたインターフェースを通じて Markdown ベースの手順ライブラリにアクセスできます。手順を Markdown ファイルとして整理することで、次のことが可能になります。

• AI プロンプト用の集中管理されたナレッジベースを作成する
• バージョン管理された構造化ガイダンス文書を維持する
• AI アシスタントが必要に応じて特定の手順を検索、取得できるようにする
• AI を活用したタスクで一貫したパターンを確立する

仕組み

サーバーは、指定されたディレクトリとそのサブディレクトリにある Markdown ファイルをインデックス化し、各ファイルを手順文書として扱います。各文書のタイトルと最初の段落を抽出して、検索可能な概要を作成します。

AI アシスタントは、次の操作を実行できます。

1. 概要とともに、利用可能なすべての手順を一覧表示する
2. ID を指定して特定の手順を取得する

特長

• シンプルなファイルシステムベースのストレージ：ディレクトリ内の Markdown ファイルだけで構成できます
• 再帰的なディレクトリスキャン：階層的なフォルダー構造で手順を整理できます
• パスのセキュリティ：ディレクトリトラバーサルや、許可されたディレクトリ外のファイルへのアクセスを防止します
• 概要の自動抽出：各文書から H1 タイトルと最初の段落を取得します
• Model Context Protocol のサポート：MCP を実装する AI アシスタントと互換性があります

前提条件

• Node.js 18+（ESM のサポート用）
• npm または yarn
• TypeScript と Markdown の基本的な知識

インストール

# Clone the repository
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer

# Install dependencies
npm install

# Build the project
npm run build

使い方

サーバーの起動

# Start with path to your instructions directory
npm start -- /path/to/instructions

# Or directly with node
node dist/index.js /path/to/instructions

手順の作成

手順は、拡張子が .md の Markdown ファイルです。各ファイルは次の構成にしてください。

# Instruction Title

Brief description of this instruction's purpose. This first paragraph will be used as the summary when listing instructions.

## Details

Additional sections with more detailed information...

## Examples

Usage examples, code samples, etc.

ディレクトリ構造の例

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

手順へのアクセス

サーバーは、2 つの MCP ツールを提供します。

1. listInstructions

ID と概要を含む、利用可能なすべての手順の一覧を返します。

応答例：

id: api/authentication
summary: Authentication API - This document outlines the authentication protocol used in our system.

id: design/typography
summary: Typography Guidelines - This guide explains our typographic scale and usage rules.

2. readInstruction

手順 ID を受け取り、対応する手順の全文を返します。

リクエスト例：{ "id": "api/authentication" }

開発

# Run in development mode with auto-restart
npm run dev -- /path/to/instructions

# Run tests
npm test

セキュリティに関する考慮事項

• サーバーは、ディレクトリトラバーサル攻撃を防ぐためにすべてのパスを検証します
• 指定された手順ディレクトリ内のファイルのみアクセスできます
• 書き込み機能はなく、読み取りのみ可能です

ライセンス

MIT

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。