MCP Filesystem

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

MCP ファイルシステムサーバは、強力で安全なファイル管理システムを提供します。ファイル操作やディレクトリ操作、メタデータアクセスなど、様々な機能を備えています。

🚀 クイックスタート

# インストール
npm install mcp-filesystem -g

# サーバーの起動
mcp-filesystem start --port 3000

# 設定ファイルの作成
mcp-filesystem --create-config config.json

# 必要に応じて config.json を編集し、サーバーを再起動

📦 インストール

MCP ファイルシステムサーバを使用するには、以下の手順に従ってください。

1. Node.js と npm/yarn のインストール

システムに Node.js（バージョン 14 以上）と npm または yarn がインストールされていることを確認してください。

2. MCP ファイルシステムサーバのインストール

npm または yarn を使用してインストールします。

npm install mcp-filesystem -g
# または
yarn global add mcp-filesystem

💻 使用例

サーバーの起動

ターミナルで以下のコマンドを実行して、MCP ファイルシステムサーバを起動します。

mcp-filesystem start --port 3000

3000 を必要なポート番号に置き換えてください。

設定ファイルの生成

設定ファイルを作成するには、以下のコマンドを実行します。

mcp-filesystem --create-config config.json

✨ 主な機能

コア機能

• ファイル操作：ファイルの読み取り、書き込み、編集、移動が可能です。
• ディレクトリ操作：ディレクトリの作成、一覧表示、ツリービューの取得、検索ができます。
• メタデータアクセス：ファイルやディレクトリの情報を確認できます。
• コマンド実行：システムコマンドを安全に実行できます。
• Docker サポート：Docker と Docker Compose を通じて簡単にデプロイできます。

新機能（v0.3.0）

• 構造化ログ記録：デバッグ、情報、警告、エラーレベルを含む詳細なログが記録されます。
• パフォーマンス指標：操作回数、エラー、実行時間を追跡できます。
• 設定管理：JSON 設定ファイルをサポートしています。
• パスキャッシュ：頻繁にアクセスするパスのパフォーマンスが向上します。
• エラー処理の改善：構造化情報を含む専用のエラータイプが用意されています。
• ファイルサイズ検証：大きすぎるファイルの読み込みを防止します。
• CLI の改善：ヘルプコマンド、バージョン情報、設定ファイルの生成機能が追加されました。

📚 ドキュメント

設定オプション

設定ファイルを作成した後、必要に応じて調整できます。以下は例です。

{
  "allowedDirectories": ["/path/to/allowed/dir1", "/path/to/allowed/dir2"],
  "logLevel": "info",
  "logFile": "/path/to/logs/mcp-filesystem.log",
  "serverName": "secure-filesystem-server",
  "serverVersion": "0.3.0",
  "cache": {
    "enabled": true,
    "maxSize": 1000,
    "ttlMs": 60000
  },
  "metrics": {
    "enabled": true,
    "reportIntervalMs": 60000
  },
  "security": {
    "maxFileSize": 10485760,
    "allowSymlinks": true,
    "validateRealPath": true
  }
}

セキュリティに関する注意事項

• 許可ディレクトリ：承認されていないアクセスを防ぐため、信頼できるパスのみを追加してください。
• ファイルサイズ制限：必要に応じて maxFileSize を設定してください。デフォルトは 10MB です。
• シンボリックリンク：セキュリティポリシーに応じて、シンボリックリンクを許可するかどうかを選択してください。

開発者情報

MCP ファイルシステムサーバは [開発者姓名] によって開発されており、強力で安全なファイル管理システムを提供することを目的としています。

ドキュメントの拡張

より詳細なドキュメントが必要な場合や問題が発生した場合は、公式ドキュメントやその他のリソースを参照してください。