Filesystem MCP Server

🚀 ファイルシステムプロトコルサーバ

このプロジェクトは、Model Context Protocol (MCP) に基づくファイルシステムプロトコルサーバです。AI モデルがコンテキストプロトコルを通じてファイルシステムとやり取りできるようにします。現在の実装では以下の機能がサポートされています。

🚀 クイックスタート

このサーバを使用するには、以下の手順に従ってください。

1. 依存関係をインストールします：npm install
2. ソースコードをコンパイルします：tsc --build
3. サーバを起動します：node dist/server.js

✨ 主な機能

• ファイル操作：ファイルとディレクトリの読み取り、書き込み、更新、削除が可能です。
• ディレクトリ管理：ディレクトリの作成、一覧表示、移動、コピーができます。
• 状態管理：セッションレベルの状態（例：デフォルトパス）を維持します。
• ログ記録とエラー処理：ログ記録とエラー処理メカニズムが統合されています。
• レート制限：乱用を防止するための保護措置があります。

📦 インストール

依存関係のインストール

npm install

ソースコードのコンパイル

tsc --build

サーバの起動

node dist/server.js

💻 使用例

基本的な使用法

//.ReadFile.ts
export async function read_file(request: ReadFileRequest): Promise<ReadFileResponse> {
    const { path } = request;
    try {
        const content = await fs.promises.readFile(path, 'utf8');
        return { success: true, content };
    } catch (error) {
        return { success: false, error: error.message };
    }
}

📚 ドキュメント

ファイルシステム構造図

+-filesystem-mcp-server/
| +-dist/                 # コンパイル後の JavaScript 出力 (npm run build を実行後に生成)
| +-logs/                # ログファイル（実行時に作成）
| +-node_modules/        # プロジェクトの依存関係
| +-src/                 # TypeScript ソースコード
|   +-config/             # 設定読み込み（index.ts）
|   +-mcp-server/         # 核心 MCP サーバロジック
|   | +-server.ts          # サーバの初期化とツールの登録
|   | +-state.ts           # セッション状態管理（例：デフォルトパス）
|   | +-tools/             # 各ツールの実装（各ツールはサブフォルダに配置）
|   | | +-readFile/
|   | | | +-index.ts
|   | | | +-readFileLogic.ts
|   | | | +-registration.ts
|   | | \-...              # その他のツール（writeFile, updateFile など）
|   +-types-global/       # 共有 TypeScript 型とインターフェース
|   | +-errors.ts          # カスタムエラークラスとコード
|   | +-mcp.ts             # MCP 関連の型
|   | \-tool.ts            # ツール定義型
|   +-utils/              # 再利用可能なユーティリティモジュール
|   | +-errorHandler.ts
|   | +-idGenerator.ts
|   | +-index.ts
|   | +-logger.ts
|   | +-rateLimiter.ts
|   | +-requestContext.ts
|   | \-sanitization.ts
|   \-index.ts            # アプリケーションのエントリポイント
| +-clinerules           # LLM コードアシスタント用のチートシート
| +-gitignore
| +-LICENSE
| +-package.json
| +-package-lock.json
| +-README.md             # このファイル
| \-tsconfig.json         # TypeScript コンパイラオプション

ツールリスト

基本ファイル操作ツール

ディレクトリ管理ツール

プロジェクト構造

核心コンポーネント

• Server.ts：サーバのメインプログラムで、接続の処理とメッセージルーティングを担当します。
• State.ts：セッションレベルの状態を維持し、デフォルトパスなどの情報を管理します。
• Tools/：各ファイル操作ツールの具体的な実装が含まれています。

🔧 技術詳細

• このプロジェクトは TypeScript で実装されており、強い型付けサポートを提供します。
• npm を使用して依存関係を管理します。
• ソースコードをコンパイルするには tsc --build を実行します。
• サーバを起動するには node dist/server.js を実行します。

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細な条項は LICENSE ファイルを参照してください。

構築チーム

• 作者：[あなたの名前]
• 貢献者：[あなたの名前]
• メンテナ：[あなたの名前]

Model Context Protocol の詳細については、公式ドキュメント を参照してください。