Bsmi021 MCP Filesystem Server

🚀 ファイルシステム MCP サーバー

MCP プロトコルに基づいて、ファイルシステムの操作、分析、管理機能を実現する標準ツールインターフェースのモデルコンテキストプロトコル (MCP) サーバーです。

🚀 クイックスタート

このサーバーは、MCP プロトコルを用いてファイルシステムの操作、分析、管理を行うことができます。以下では、その構造、インストール方法、使用方法などを説明します。

✨ 主な機能

• ファイルシステム操作、分析、管理機能を提供します。
• MCP プロトコルに基づいて構築されています。
• 異なるレイヤーに分かれており、各レイヤーが特定の機能を担っています。

🏗️ 構造

このサーバーは MCP SDK をベースに構築されており、以下のように異なるレイヤーに分けられています。

graph TD
    A[ MCP サーバー層 ] --> B[ ツールレジストリ ]
    B --> C[ 操作層 ]
    C --> D[ ファイルシステム操作 ]
    C --> E[ 分析操作 ]
    C --> F[ ストリーム操作 ]

コンポーネント

• サーバー層：MCP プロトコルの通信とツールのスケジューリングを処理します。
• ツールレジストリ：ツールの登録と実行を管理します。
• 操作層：核心機能を実装します。
• ファイルシステムインターフェース：安全なファイルシステムアクセスを提供します。

📦 インストール

以下の手順に従ってサーバーをインストールしてください。

1. リポジトリをクローンします。

git clone <repository-url>
cd filesystem-server

2. 依存関係をインストールします。

npm install

3. サーバーをビルドします。

npm run build

4. MCP 設定（cline_mcp_settings.json）を構成します。

{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["path/to/filesystem-server/build/index.js"]
    }
  }
}

💻 使用例

ディレクトリ操作

list_directory

ディレクトリの内容とそのメタデータをリストします。

インターフェース：

interface ListDirectoryParams {
  /** リストするディレクトリのパス */
  path: string;
}

interface ListDirectoryResult {
  /** ディレクトリ内のファイルとサブディレクトリのリスト */
  entries: Array<{
    /** ファイルまたはサブディレクトリの名前 */
    name: string;
    /** ファイルタイプ（'file' または 'directory'） */
    type: string;
    /** 変更日時 */
    modifiedTime: Date;
  }>;
}

サンプル：

const result = await filesystem.listFiles('/path/to/dir');
// 結果の構造は上記の通りです

ファイル操作

read_file

ファイルの内容を読み取ります。

インターフェース：

interface ReadFileParams {
  /** 読み取るファイルのパス */
  path: string;
}

interface ReadFileResult {
  /** ファイルの内容（バイナリバッファ） */
  content: Buffer;
}

サンプル：

const content = await filesystem.readFile('/path/to/file.txt');
// content にはファイルのデータが含まれます

write_file

ファイルに内容を書き込みます。

インターフェース：

interface WriteFileParams {
  /** 書き込むファイルのパス */
  path: string;
  /** ファイルの内容 */
  content: Buffer | string;
}

interface WriteFileResult {
  /** 書き込まれたバイト数 */
  bytesWritten: number;
}

サンプル：

const result = await filesystem.writeFile('/path/to/file.txt', '書き込む内容');
// 書き込まれたバイト数が返されます

エラー処理

エラーコードとメッセージ

• 400 Bad Request：無効なリクエストパラメータです。
• 401 Unauthorized：操作を実行する権限がありません。
• 404 Not Found：指定されたファイルまたはディレクトリが存在しません。
• 500 Internal Server Error：サーバー内部エラーです。

開発モード

監視モード

npm run watch

コード品質

コードをチェックします。

npm run lint

型チェックを行います。

npm run type-check

🤝 貢献ガイド

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 新しい機能に対するテストを作成します。
4. すべてのテストが通過することを確認します。
5. プルリクエストを送信します。

📄 ライセンス

MITライセンスの下で公開されています。