Bsmi021 MCP File Operations Server

🚀 ファイル操作 MCP サーバー

拡張されたファイル操作機能を提供するモデルコンテキストプロトコル（MCP）サーバーです。ストリーミング、パッチ処理、変更追跡をサポートしています。

✨ 主な機能

• 基本的なファイル操作：ファイルのコピー、読み取り、書き込み、移動、削除
• ディレクトリ操作：ディレクトリの作成、削除、コピー
• ファイル監視：ファイルとディレクトリの変更を監視
• 変更追跡：ファイル操作の履歴を追跡し、照会
• ストリーミングサポート：大きなファイルを効率的に処理
• リソースアクセス：MCP リソースを通じてファイルとディレクトリにアクセス
• 進捗報告：長時間の操作におけるリアルタイムの進捗更新
• レート制限：過度のリクエストを防止する保護機能
• 強化されたセキュリティ：パスの検証と入力のクリーニング
• 堅牢なエラー処理：包括的なエラー処理と報告
• 型安全：完全な TypeScript サポートと厳格な型チェック

📦 インストール

史密斯ery を通じたインストール

1. https://smithery.ai/ にアクセスします。
2. ログインし、「ワークスペース」に移動します。
3. 「コードリポジトリから新しいワークスペースを作成」をクリックします。
4. URL 欄にリポジトリのアドレスを入力します：git+ssh://github.com/bsmi021/mcp-file-operations-server.git
5. ワークスペースの設定を完了したら、「作成」をクリックします。

手動インストール

1. このリポジトリをクローンします：

git clone git@github.com:bsmi021/mcp-file-operations-server.git
cd mcp-file-operations-server

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

npm install

3. サーバーを起動します：

node src/index.js

💻 使用例

基本的な使用法

機能概要

• ファイル操作：ファイルのコピー、移動、読み取り、書き込みをサポート。
• ディレクトリ管理：ディレクトリ構造の作成、削除、走査。
• 変更追跡：ファイルの変更履歴を記録し、検索。
• ストリーミング：大きなファイルを処理する際の効率的なチャンク転送。

コード例

1. 新しいファイルを作成する：

POST /operations/create-file
Content-Type: application/json

{
  "path": "example.txt",
  "content": "Hello, World!"
}

2. ファイルをコピーする：

POST /operations/copy-file
Content-Type: application/json

{
  "sourcePath": "example.txt",
  "destinationPath": "copy_example.txt"
}

3. ファイルの内容を読み取る：

GET /operations/read-file?path=example.txt

高度な使用法

リソースアクセス

• ファイルリソース：パスを通じて特定のファイルにアクセス。
• ディレクトリリソース：ディレクトリ内のすべてのファイルとサブディレクトリをリストアップ。

📚 ドキュメント

プロジェクト構造

1. コアモジュール

   • file-system：ファイルとディレクトリの基本操作を処理。
   • operations：様々なファイル操作ツールを含む。
   • resources：アクセス可能なリソースインターフェースを定義。

2. ログシステム

// ログ記録器を設定
const logger = require('mcp-logger');

// 異なるレベルのログ情報を記録
logger.debug("デバッグ情報");
logger.info("一般情報");
logger.warn("警告情報");
logger.error("エラー情報");

依存関係管理

このプロジェクトは npm を使用して依存関係を管理しています。主な依存関係は以下の通りです。

• express：Web サーバーフレームワーク。
• mcp-core：MCP プロトコルのコアライブラリ。
• fs-extra：拡張されたファイルシステム操作。

エラー処理

標準エラーコード

1. InvalidRequest：リクエストの形式またはパラメータが無効。
2. MethodNotFound：リクエストされたツールまたはリソースが存在しない。
3. InvalidParams：パラメータの検証に失敗（例：無効なパス）。
4. InternalError：サーバー内部エラー。

カスタムエラータイプ

• ファイル操作の失敗
• レート制限の超過
• パス検証エラー
• リソースアクセスエラー

各エラーには、エラーコード、具体的なメッセージ、関連するメタデータを含む詳細なコンテキスト情報が含まれています。

設定オプション

config.json を通じてサーバーの動作を定義します。

{
  "rateLimits": {
    "requestsPerMinute": 100,
    "windowMs": 60000
  },
  "progressReporting": {
    "updateInterval": 1000,
    "detailLevel": "high"
  }
}

貢献ガイド

1. プロジェクトに参加する：Issues を確認し、適切なタスクを見つけます。
2. コードを提出する：
   • 機能ブランチを作成します：git checkout -b feature/amazing-feature
   • 変更をコミットします：git commit -m 'amazing 機能を追加'
   • リモートリポジトリにプッシュします：git push origin feature/amazing-feature
3. プルリクエストを作成する：Pull Requests に移動し、あなたの貢献を提出します。

📄 ライセンス

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