Filesystem MCP Server (@shtse8filesystem Mcp)

🚀 ファイルシステム MCP サーバ (@sylphlab/filesystem-mcp)

このツールキットは、Model [Context Protocol](https://github.com/Modelคณะกรรม parchain/model-context-protocol) に準拠したファイルシステムツールキットです。標準的な入出力プロトコルを通じて、ファイルシステムを強力に制御でき、AIエージェントや、効率的なファイル操作が必要なアプリケーションに最適です。

🚀 クイックスタート

このファイルシステムMCPサーバは、Model Context Protocolに準拠したツールキットで、AIエージェントやその他のアプリケーションに強力なファイル操作機能を提供します。以下のセクションでは、その機能、インストール方法、使用例などを詳しく説明します。

✨ 主な機能

このサーバは、AIエージェントに強力なファイルシステムツールボックスを提供します。

• ファイルとディレクトリ管理：ファイルやディレクトリの作成、削除、移動、コピーが可能です。
• 内容の読み書き：ファイル内容の読み取り、書き込み、追加ができ、親ディレクトリを再帰的に作成することもサポートしています。
• 権限制御：ファイルやディレクトリのPOSIX権限と所有者を変更できます。
• 検索と置換：複数のファイル内で正確な編集、検索、置換が可能です。
• リストと統計：ファイルやディレクトリをリストアップ（再帰的に指定可能）し、詳細な状態情報を取得できます。

すべてのツールはバッチ処理操作をサポートしており、各操作は詳細な実行結果レポートを返します。

🔧 技術詳細

このファイルシステムMCPサーバには、以下のような核心的な利点があります。

1. 効率性：バッチ処理により通信オーバーヘッドを削減し、AIエージェントの呼び出し回数を減らします。
2. 安全性：操作をプロジェクトのルートディレクトリ内に厳格に制限し、越界アクセスを防止します。
3. 信頼性：詳細なエラーレポートと成功状態情報を提供します。
4. 使いやすさ：統一されたAPIインターフェースに従っており、統合プロセスを簡素化します。

📦 インストール

npmを通じたインストール

npm install @sylphlab/filesystem-mcp

💻 使用例

基本的な使用法

import { createClient } from '@sylphlab/filesystem-mcp';

const client = createClient();

// 例：カレントディレクトリ内のファイルとサブディレクトリをリストアップ
client.listFiles({
  path: '.',
  recursive: false,
  showHidden: true,
}).then((result) => {
  console.log('操作結果:', result);
});

📚 ドキュメント

• 完全なドキュメント：詳細なAPIリファレンスと使用例を含む完全なドキュメントは、ドキュメントサイトをご覧ください。
• プロトコル仕様：Model Context Protocolに準拠しており、AIエージェントとの互換性を保証します。

🔧 開発

1. リポジトリをクローンする：

   git clone https://github.com/sylphlab/filesystem-mcp.git
   

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

   cd filesystem-mcp && pnpm install
   

3. プロジェクトをビルドする：

   pnpm run build
   

4. 開発を監視する（オプション）：

   pnpm run dev
   

🚀 リリース

このリポジトリはGitHub Actionsを使用して自動化されたリリースプロセスを行っています。

• npmリリース：バージョンタグ (v*.*.*) を main ブランチにプッシュすると、自動的にnpmにリリースされます。
• Dockerイメージのビルドとプッシュ：同時にDockerイメージをビルドし、Docker Hubにプッシュします。

GitHubリポジトリの設定で以下のシークレットを設定する必要があります。

• NPM_TOKEN
• DOCKERHUB_USERNAME
• DOCKERHUB_TOKEN

🤝 貢献

貢献を歓迎します！問題やプルリクエストは GitHubリポジトリ を通じて提出してください。

📄 ライセンス

このプロジェクトは MIT License で公開されています。