Fs MCP Server

🚀 ファイルシステムサーバーツールドキュメント

このファイルシステムサーバーツールは、ファイルやディレクトリを管理するための一連の操作を提供します。ファイル内容の表示、ファイルの読み取り、ファイルの検索、ファイルの編集、アクセスが許可されたディレクトリの表示など、様々な機能をサポートしています。

🚀 クイックスタート

このファイルシステムサーバーツールは、ファイルやディレクトリの管理操作を提供します。以下では、サーバーのインストール、実行、クライアントの統合、開発に関する手順を説明します。

✨ 主な機能

• クロスプラットフォーム対応：Linux、macOS、Windowsで動作します。
• 強力な権限管理：アクセスが許可されたディレクトリを設定することで、操作の安全性を確保します。
• 高い操作性能：ファイル操作の速度を最適化しており、大量のデータを扱うのに適しています。
• 柔軟な設定オプション：コマンドライン引数または設定ファイルで動作をカスタマイズできます。

📦 インストール

サーバーのインストールと実行

Linuxでの実行：

# 先下载可执行文件
wget https://example.com/fs-mcp-server_linux

# 给予执行权限
chmod +x fs-mcp-server_linux

# 运行服务器
./fs-mcp-server_linux

macOSでの実行：

# 下载并解压
tar -xvf fs-mcp-server_macos.tar.gz

# 运行服务器
./fs-mcp-server_macos

Windowsでの実行：

# 下载可执行文件
# 双击文件运行

アクセスが許可されたディレクトリの設定

サーバーを起動する前に、アクセスが許可されたディレクトリを設定する必要があります。以下のコマンドで、アクセスが許可されたディレクトリを表示できます。

# 列出允许访问的目录
./fs-mcp-server_linux --list-allowed-dirs

# 添加新的允许访问目录
./fs-mcp-server_linux --add-allowed-dir /path/to/directory

# 除不再需要的目录
./fs-mcp-server_linux --remove-allowed-dir /path/to/directory

💻 使用例

クライアントの統合

以下は、Rust言語を使用してサーバーツールを呼び出すクライアントの例です。

use mcp_client::{ClientBuilder, transport::StdioTransport};
use serde_json::json;

#[tokio::main]
async fn main() -> Result<()> {
    // 服务器可执行文件路径
    let server_path = "path/to/fs-mcp-server";
    
    // 创建并连接到服务器
    let (transport, mut receiver) = StdioTransport::new(server_path, vec![]);
    
    let client = ClientBuilder::new("fs-client", "0.1.0")
        .with_transport(transport)
        .build()?;
    
    // 启动消息处理
    let client_for_handler = client.clone();
    tokio::spawn(async move {
        while let Some(message) = receiver.recv().await {
            if let Err(e) = client_for_handler.handle_message(message).await {
                eprintln!("处理消息时出错: {}", e);
            }
        }
    });
    
    // 初始化客户端
    let init_result = client.initialize().await?;
    println!("连接到服务器：{} v{}", init_result.server_info.name, init_result.server_info.version);
    
    // 列出所有允许访问的目录
    let allowed_dirs_result = client.call_tool("list_allowed_dirs", &json!({})).await?;
    println!("允许访问的目录: {:?}", allowed_dirs_result);
    
    // 列出指定目录的内容
    let list_dir_result = client.call_tool("list_dir", &json!({"path": "/your/directory/path"})).await?;
    println!("目录内容: {:?}", list_dir_result);
    
    // 读取文件内容
    let read_file_result = client.call_tool("read_file", &json!({"file_path": "/path/to/file.txt"})).await?;
    println!("文件内容: {}", String::from_utf8(read_file_result).unwrap());
    
    // 搜索文件
    let search_result = client.call_tool("search_files", &json!({
        "pattern": "*.txt",
        "directories": ["/path/to/search"]
    })).await?;
    println!("搜索结果: {:?}", search_result);
    
    // 编辑文件内容
    let edit_file_result = client.call_tool("edit_file", &json!({
        "file_path": "/path/to/file.txt",
        "content": "新的文件内容"
    })).await?;
    println!("编辑文件完成: {}", edit_file_result);
    
    Ok(())
}

📚 ドキュメント

開発ガイド

プロジェクト構造

.
├── README.md               # 项目说明文档
├── LICENSE                # 许可证文件
├── Cargo.toml              # Rust项目的依赖管理文件
├── src/
│   ├── main.rs            # 服务器入口程序
│   └── lib.rs             # 核心功能实现
└── scripts/               # 脚本目录，包含各种工具脚本

ビルド手順

Linuxでのビルド：

# 克隆项目仓库
git clone https://github.com/your-username/fs-mcp-server.git

# 进入项目目录
cd fs-mcp-server

# 使用Rust构建
cargo build --release

macOSでのビルド：

# 克隆项目仓库
git clone https://github.com/your-username/fs-mcp-server.git

# 进入项目目录
cd fs-mcp-server

# 使用Rust构建
cargo build --release

Windowsでのビルド：

# 设置 Rust 环境变量
# 克隆项目仓库并进入目录后运行
cargo build --release

コード例

アクセスが許可されたディレクトリの表示

fn list_allowed_dirs() -> Vec<String> {
    // 读取配置文件，获取允许访问的目录列表
    let config = read_config();
    config.allowed_dirs.clone()
}

ファイル内容の読み取り

fn read_file(file_path: &str) -> Option<Vec<u8>> {
    match fs::read(file_path) {
        Ok(content) => Some(content),
        Err(e) => {
            eprintln!("无法读取文件：{}", e);
            None
        }
    }
}

ファイルの検索

fn search_files(pattern: &str, directories: Vec<&str>) -> Vec<String> {
    let mut results = Vec::new();
    
    for dir in directories {
        if Path::exists(dir) && Path::is_dir(dir) {
            for entry in fs::read_dir(dir).unwrap() {
                let entry_path = entry.path().to_str().unwrap();
                if entry_path.ends_with(pattern) {
                    results.push(entry_path.to_string());
                }
            }
        }
    }
    
    results
}

ファイル内容の編集

fn edit_file(file_path: &str, content: String) -> bool {
    match fs::write(file_path, content) {
        Ok(_) => true,
        Err(e) => {
            eprintln!("无法写入文件：{}", e);
            false
        }
    }
}

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細な条項は、LICENSEファイルを参照してください。

貢献ガイド

コミュニティからの貢献を歓迎します！何か問題や提案があれば、GitHubリポジトリにIssuesを投稿してください。