Simple MCP Fileserver

🚀 シンプルMCPファイルサーバ

Simple MCP FileServerは、MCPプロトコルに基づく軽量級のファイルサービス実装です。これにより、ネットワークを介してファイルやディレクトリの基本操作（読み取り、書き込み、ディレクトリ内容の一覧表示など）を行うことができます。

🚀 クイックスタート

Simple MCP FileServerは、MCPプロトコルを利用したファイルサービスで、ネットワーク経由でファイルやディレクトリの基本操作が可能です。以下に、基本的な使い方を説明します。

基本的な使用法

1. サービスを起動する：

node index.js --port 8090 --address 0.0.0.0

2. リクエストを送信する：

• ファイルの読み取り：

curl http://localhost:8090/file/read/path/to/file.txt

• ファイルの書き込み：

curl -X POST -d "content=your content" http://localhost:8090/file/write/path/to/file.txt

• ディレクトリの一覧表示：

curl http://localhost:8090/dir/list/path/to/directory

✨ 主な機能

コア機能

• ファイル読み取り：指定されたパスからファイル内容を読み取ります。
• ファイル書き込み：指定されたパスに内容を書き込みます。
• ディレクトリ走査：指定されたディレクトリ内のすべてのファイルとサブディレクトリを一覧表示します。
• ヘルスチェック：簡単なヘルスチェックエンドポイントを提供します。

拡張性

• カスタムプラグインシステムをサポートしています。
• 拡張可能なプロトコルサポートを備えています。

📦 インストール

インストール手順

1. ソースコードをダウンロードする：

git clone https://github.com/yourusername/simple-mcp-fileserver.git

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

npm install

3. サービスを起動する：

node index.js

設定オプション

• リッスンアドレス：サーバーがバインドするIPアドレスを指定します。デフォルトは0.0.0.0です。
• リッスンポート：サーバーがリッスンするTCPポートを指定します。デフォルトは8090です。
• 許可ディレクトリ：アクセス可能なディレクトリのリストを設定します。
• 認証方式：トークンベースまたはユーザー名/パスワードなど、複数の認証メカニズムをサポートしています。

📚 ドキュメント

MCPプロトコルの説明

MCP（Multi-Channel Protocol）は、ネットワークデータ転送に使用されるプロトコルで、複数のチャネルとデータ形式をサポートしています。MCPプロトコルの特徴は以下の通りです。

1. マルチチャネル通信をサポートしています。
2. 効率的なデータシリアライゼーションを行います。
3. 拡張しやすいプラグインシステムを備えています。

動作原理

コアコンポーネント

1. ファイルサービス
   • 読み取り、書き込み、削除などの基本的なファイル操作を提供します。
   • ディレクトリの走査をサポートしています。
2. ネットワーク通信
   • TCP/IPプロトコルを使用してデータを転送します。
   • リクエストのマルチスレッド処理をサポートしています。
3. セキュリティ
   • 権限に基づいたアクセス制御を行います。
   • SSL/TLS暗号化オプションを提供します。

APIリファレンス

コアインターフェース

1. GET /file/read/{path}
   • 指定されたパスのファイル内容を読み取ります。
   • 戻り値：ファイル内容を文字列として返します。
2. POST /file/write/{path}
   • 指定されたパスに内容を書き込みます。
   • リクエストボディ：{content: string}
   • 戻り値：ok
3. GET /dir/list/{path}
   • 指定されたディレクトリ内のすべてのファイルとサブディレクトリを一覧表示します。
   • 戻り値：ファイルとディレクトリ名の配列を返します。

拡張インターフェース

• プラグインシステムを通じて、圧縮、暗号化などのさらなる機能を拡張できます。

ヘルスチェック

サーバーは簡単なヘルスチェックエンドポイントを提供しています。

curl http://localhost:8090/health
# 戻り値：ok

トラブルシューティング

一般的な問題

1. 初期化に失敗した場合：
   • サービスが実行中であることを確認してください。
   • 対象ポートが使用中でないことを確認してください。
   • /healthエンドポイントがokを返すことを確認してください。
2. ポートの競合が発生した場合：
   • lsof -i :<port>コマンドを使用してポートの使用状況を確認してください。
   • 異なるポートでサービスを起動してください。
3. 権限の問題が発生した場合：
   • サーバーがリクエストされたファイルパスにアクセスする権限を持っていることを確認してください。

セキュリティ上の注意事項

このサーバーはファイルシステムへの直接アクセスを提供します。以下のセキュリティ対策を検討してください。

• 信頼できるネットワーク上でサーバーを実行してください。
• アクセス可能なディレクトリの範囲を制限してください。
• 本番環境では認証を実装することを検討してください。
• サーバーログ内の疑わしい活動を監視してください。

潜在的な改善方向

このMCPサーバーは、以下の機能を拡張することができます。

1. 認証と承認：ユーザー認証とパスベースの権限制御を追加する。
2. ファイル監視：ファイルの変更に対する通知メカニズムを実装する。
3. データ圧縮：gzipなどの圧縮形式をサポートする。
4. 暗号化転送：SSL/TLS暗号化をデフォルトで有効にする。

プロジェクトのURL

• GitHub

貢献者

このプロジェクトに貢献してくれた以下の方々に感謝します。

• [Your Name]
• [Contributor Name]

ライセンス

版权所有 (c) 2023, Your Name.