MCP File Navigator

🚀 MCP 文件サーバ

MCP ファイルサーバは、Node.js をベースにしたモジュール型ファイル管理ツールで、様々なファイル操作機能をサポートしています。異なるサービスを設定することで、圧縮、暗号化、またはその他のカスタムニーズを実現するように機能を拡張することができます。

🚀 クイックスタート

📦 インストール

依存関係のインストール

npm install express fs-extra shelljs

サーバの起動

node mcp_server.js

デフォルトのポートは 3000 です。ポートを変更する場合は、起動時に指定してください。

PORT=8080 node mcp_server.js

✨ 主な機能

基本ディレクトリの設定

パラメータ:

• path: 新しい基本ディレクトリのパス（絶対パスである必要があります）

戻り値:

• 確認メッセージ

現在の基本ディレクトリの取得

パラメータ:

• なし

戻り値:

• 現在の基本ディレクトリのパス

ファイルの一覧表示

パラメータ:

• directory (オプション): 一覧表示するディレクトリのパス（デフォルトはルートディレクトリ）

戻り値:

• ファイルとディレクトリのフォーマットされたリスト

ファイル内容の読み取り

パラメータ:

• path: 読み取るファイルのパス

戻り値:

• ファイルの内容

ファイルの書き込み

パラメータ:

• path: 書き込むファイルのパス
• content: 書き込む内容

戻り値:

• 確認メッセージ

ファイルまたはディレクトリの削除

パラメータ:

• path: 削除するファイルまたはディレクトリのパス

戻り値:

• 確認メッセージ

拡張機能

Git コマンドの実行

基本ディレクトリで Git コマンドを実行します。

パラメータ:

• command: 実行する Git コマンド（git 接頭辞なし）
• shell (オプション): コマンドを実行するシェル（cmd、powershell、bash）

戻り値:

• コマンドの出力（標準出力とエラー出力）

ログとデバッグ

サーバの操作の詳細情報や発生した可能性のあるエラーを取得するには、log/mcp_debug.log にあるログファイルを確認してください。

問題のトラブルシューティング

一般的な問題と解決策は以下の通りです。

1. パスアクセスエラー: BASE_DIRECTORY がプロセスがアクセスできる場所に設定されていることを確認してください。
2. 接続拒否: サーバが実行中であることを確認してください。
3. ツールが見つからない: 設定ファイルのツール名がサーバで定義されているものと完全に一致していることを検証してください。
4. ポート競合: 複数の MCP サービスを実行する場合は、異なるポートを使用するようにしてください。
5. 無効な基本ディレクトリ: チャットから基本ディレクトリを設定する場合は、絶対パス（相対パスではない）を指定してください。
6. Git コマンドエラー: Git がインストールされており、基本ディレクトリが有効な Git リポジトリであることを確認してください。

貢献ガイド

貢献の方法

• 問題報告の提出: 再現手順を添えた詳細なエラー報告を提出してください。
• 機能リクエスト: 新しい機能や改善提案を提出してください。
• ドキュメントの改善: 既存のドキュメントを完成させるか拡張するのを手伝ってください。
• コードの貢献: エラー修正や新機能の実装を含むプルリクエストを提出してください。

開発フロー

1. ブランチの作成: 自分のリポジトリで、各機能または修正に対して独立したブランチを作成してください。
2. コーディング規約の遵守: コードスタイルの一貫性を保ってください。
3. テストの作成: 新しい機能や修正に対応するテストケースを追加してください。
4. ドキュメントの更新: 行った変更を反映するように関連するドキュメントを変更してください。
5. プルリクエストの提出: 変更内容を明確に説明したプルリクエストを提出してください。

プルリクエストガイド

• 各 PR は単一の機能または修正に集中するようにしてください。
• 変更の詳細な説明と理由を含めてください。
• すべてのテストが通過することを確認してください。
• 特に指定がない限り、英語を主要言語として使用してください。

ドキュメントの履歴

• バージョン 1.0: 最初のリリース（2023年10月）
• バージョン 1.1: Git コマンドのサポートとログ機能の追加（2023年11月）

詳細な情報やヘルプが必要な場合は、プロジェクトのドキュメントを参照するか、メンテナンスチームに連絡してください。