🚀 より良いMCPファイルサーバー

BetterMCPFileServerは、最適化されたファイルサーバーで、効率的で安全かつ使いやすいファイル管理体験を提供することを目的としています。コマンドラインインターフェイスを通じて複数のディレクトリをマウントし、シンプルなAPIでファイル操作を行うことができます。

🚀 クイックスタート

BetterMCPFileServerを起動する際には、少なくとも1つのエイリアスとディレクトリのマッピング関係を指定する必要があります。

BetterMCPFileServer エイリアス:ディレクトリ [エイリアス2:ディレクトリ2 ...]

例

単一のディレクトリ:
```
BetterMCPFileServer code:~/projects
```

複数のディレクトリ:

BetterMCPFileServer code:~/Development docs:~/Documents/Technical notes:~/Notes

✨ 主な機能

核心機能

ファイルの書き込み：ファイルを作成または更新します。
内容の読み取り：指定されたファイルの内容を取得します。
ファイルの編集：特定の部分を変更します。
ファイル管理：移動、名前の変更、コピー、または削除操作を実行します。
ディレクトリ管理：ディレクトリの作成、名前の変更、または削除を行います。
検索機能：パターンマッチングを使用してファイルとディレクトリを検索します。

パターンマッチングの例

*：トップレベルの項目をリストする（簡単なディレクトリリストのようなもの）。
projects/*.js：projectsディレクトリ内のすべての.jsファイル。
**/*.md：すべてのMarkdownファイルを再帰的に検索します。

📦 インストール

npmを使用したインストール（近日公開予定）

npm install -g BetterMCPFileServer  # まだ利用できません

# ソースコードからのインストール（現在の方法）
git clone https://github.com/martinschlott/BetterMCPFileServer.git
cd BetterMCPFileServer
npm install
npm run build
npm link  # オプション、コマンドをグローバルで使用する場合

💻 使用例

基本的な使用法

仮想ルートディレクトリの操作

// すべてのエイリアスをリストする
searchFilesAndFolders({ pattern: "*" })

// 結果の例:
[
  { name: 'code', type: 'directory' },
  { name: 'docs', type: 'directory' }
]

ファイル管理操作

writeFile({
  filePath: "projects/test.txt",
  content: "Hello, World!"
});

readFileContent({
  filePath: "projects/test.txt"
});

// 返り値: "Hello, World!"

高度な使用法

高度な設定のために、シェルスクリプトを作成して設定を統一することができます。

#!/bin/bash
# start-server.sh
BetterMCPFileServer \
  code:~/Development/MyProjects \
  docs:~/Documents/Technical \
  data:~/Data/Samples \
  config:~/Configuration

📚 ドキュメント

BetterMCPFileServerは、すべてのファイルシステム操作をカバーする6つの強力なAPI関数を提供します。

1. `writeFile`

ファイルを作成または更新します。

writeFile({
  filePath: "projects/README.md",
  content: "# My Project\n\nThis is a readme file."
})

2. `readFileContent`

ファイルの内容を読み取ります。

readFileContent({
  filePath: "projects/README.md"
})

3. `editFile`

ファイルの特定の部分を編集します。

editFile({
  filePath: "projects/README.md",
  edits: [
    {
      oldText: "# My Project",
      newText: "# Awesome Project"
    }
  ],
  dryRun: false
})

4. `manageFile`

ファイル操作（移動、名前の変更、コピー、削除）を実行します。

manageFile({
  action: "move",
  filePath: "projects/old.js",
  newFilePath: "projects/new.js"
})

5. `manageFolder`

ディレクトリ管理（作成、名前の変更、削除）を行います。

manageFolder({
  action: "create",
  folderPath: "projects/new-directory"
})

6. `searchFilesAndFolders`

パターンマッチングを使用してファイルとディレクトリを検索します。

searchFilesAndFolders({
  pattern: "projects/**/*.ts",
  includeMetadata: false
})

🔧 技術詳細

注意事項

⚠️ 重要提示

エイリアスはシステム内で一意であることを確認し、衝突を避けてください。

サーバーを実行するには、指定されたディレクトリにアクセスするための十分な権限が必要です。

大きなファイルや頻繁な操作の場合は、適切なページングとフィルタリングメカニズムを使用することをお勧めします。