Stela MCP

🚀 STeLA MCP プロジェクトドキュメント

STeLA MCP は、ローカルシステムでのコマンド実行とファイル操作機能を提供するサーバーです。安全かつ設定可能なインターフェースを通じて、ユーザーがファイルやディレクトリを管理・操作できるように設計されています。ユーザーは、アクセスを許可するディレクトリとサポートされるコマンドを設定することで、サーバーの機能をコントロールできます。

🚀 クイックスタート

STeLA MCP を使用するには、まずインストールと基本的な設定が必要です。以下の手順に従って、サーバーを起動しましょう。

✨ 主な機能

STeLA MCP は、ローカルシステムでのコマンド実行とファイル操作を安全に行うための機能を提供します。主な機能は以下の通りです。

• コマンド実行ツール：システムコマンドやスクリプトを実行できます。
• ファイルシステムツール：ファイルやディレクトリの操作、検索が可能です。

📦 インストール

ソースコードからのインストール

1. リポジトリをクローンします。

git clone git@github.com:username/repo.git
cd repo

2. 依存関係をインストールします。

pip install -r requirements.txt

3. サーバーを起動します。

python server.py

PyPI からのインストール

pip install stela-mcp

📚 ドキュメント

設定の説明

サーバーを起動する前に、基本的な設定が必要です。主な設定ファイルは server_config.yaml で、以下の重要な設定が含まれています。

• allowed_directories: アクセスを許可するディレクトリのリスト。
• enabled_commands: 実行をサポートするコマンドのリスト。
• security_rules: セキュリティ関連の設定（ユーザー権限やログ記録など）。

設定例

# server_config.yaml

logging:
  level: INFO
  file: mcp.log

allowed_directories:
  - /home/user/data
  - /var/www

enabled_commands:
  - ls
  - cp
  - mv
  - rm

security_rules:
  allow_root: false
  log_access: true

機能モジュール

コマンド実行ツール

STeLA MCP は、制御された環境でシステムコマンドを実行するためのツールを提供します。主な機能は以下の通りです。

• execute_command: 単一のコマンドを実行します。
• script_execution: 事前定義されたスクリプトを実行します。

使用例

curl -X POST http://localhost:8000/api/v1/commands \
  -H "Content-Type: application/json" \
  -d '{"command": "ls -a", "args": []}'

ファイルシステムツール

STeLA MCP は、ファイルやディレクトリの操作を効率的に行うためのツールを提供します。主な機能は以下の通りです。

• file_operations: ファイルの作成、削除、移動、名前変更などの操作が可能です。
• directory_management: ディレクトリの作成、削除、一覧表示ができます。
• search_tools: 名前でファイルやディレクトリを検索できます。

使用例

curl -X POST http://localhost:8000/api/v1/files \
  -H "Content-Type: application/json" \
  -d '{"operation": "create_directory", "path": "/var/www/new_dir"}'

セキュリティに関する注意事項

STeLA MCP はローカルシステムでのコマンド実行とファイル操作を提供するため、使用時には注意が必要です。以下のセキュリティ上の推奨事項を守ってください。

• 権限管理: サーバーを root または管理者権限で実行しないでください。
• 信頼できる環境: 信頼できる環境でのみ使用してください。
• 設定制限: 具体的なシナリオに合わせて、最も厳格な設定を使用してください。
• パス検証: 厳格なパスチェックを実施し、不正なアクセスを防止してください。

プラットフォーム固有のセキュリティ注意事項

Linux/macOS

• 専用のユーザーアカウントを使用し、限定された権限を付与してください。
• chroot 環境を使用して、ファイルシステムへのアクセスを制限してください。
• chmod を使用して、実行権限を制限してください。
• SELinux または AppArmor を使用して、追加の保護を行ってください。

Windows

• サーバーを管理者権限で実行しないでください。
• Windows のセキュリティ機能を使用して、アクセスを制限してください。
• フォルダやファイルの権限を設定し、敏感なディレクトリへのアクセスを防止してください。
• Windows Defender アプリケーションコントロールを使用してみてください。

開発ガイド

プロジェクト構造

STeLA MCP のソースコード構造は以下の通りです。

stela-mcp/
├── server.py           # メインサーバーファイル
├── commands/          # サポートされるコマンドモジュール
│   ├── __init__.py
│   └── file_ops.py    # ファイル操作関連のコマンド
├── config/            # 設定管理モジュール
│   ├── __init__.py
│   └── server_config.yaml.example  # 設定ファイルの例
└── utils/             # ユーティリティ関数
    ├── logger.py      # ログ記録ツール
    └── validators.py  # データ検証ツール

開発手順

1. リポジトリをクローンします。

git clone git@github.com:username/stela-mcp.git
cd stela-mcp

2. 依存関係をインストールします。

pip install -r requirements.txt

3. 開発用サーバーを起動します。

python server.py --dev

ドキュメントの履歴

• バージョン 1.0: 基本的なコマンドとファイル操作機能を含む初期リリース。
• バージョン 2.0: ディレクトリ制限と強化されたセキュリティ機構の導入。
• バージョン 3.0: スクリプト実行と高度なファイル管理機能のサポート。

詳細な情報については、STeLA MCP 公式ドキュメント を参照してください。