Stela MCP

🚀 STeLA MCP 項目文檔

STeLA MCP 服務器可對本地系統執行命令和操作文件。它為用戶打造了安全且可配置的接口，用於管理文件和目錄。用戶能通過配置允許訪問的目錄和支持的命令，對服務器功能加以控制。

🚀 快速開始

STeLA MCP 是一個提供對本地系統進行命令執行和文件操作功能的服務器。你可以按照以下步驟進行安裝和啟動。

✨ 主要特性

• 命令執行工具：提供 execute_command 執行單個命令，script_execution 運行預定義腳本。
• 文件系統工具：涵蓋文件操作（創建、刪除、移動和重命名文件）、目錄管理（創建、刪除和列出目錄）以及搜索工具（按名稱搜索文件或目錄）。
• 安全機制：支持配置允許訪問的目錄、支持的命令以及安全規則，如用戶權限和日誌記錄。

📦 安裝指南

從源碼安裝

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

💻 使用示例

命令執行工具 - 基礎用法

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

文件系統工具 - 基礎用法

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 的源碼結構如下：

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

⚠️ 安全注意事項

STeLA MCP 提供對本地系統執行命令和文件操作的功能，使用時需謹慎。

⚠️ 重要提示

• 權限控制：避免以 root 或管理員身份運行服務器。
• 受信任環境：僅在可信環境中使用。
• 配置限制：使用最嚴格的配置以適應具體場景。
• 路徑驗證：實施嚴格的路徑檢查，防止越權訪問。

平臺特定安全注意事項

Linux/macOS

• 使用專用用戶賬戶並授予有限權限。
• 考慮使用 chroot 環境來限制文件系統訪問。
• 使用 chmod 限制可執行權限。
• 考慮採用 SELinux 或 AppArmor 進行額外保護。

Windows

• 避免以管理員身份運行服務器。
• 使用 Windows 安全功能限制訪問。
• 設置文件夾和文件的權限，防止訪問敏感目錄。
• 考慮使用 Windows Defender 應用控制。

📄 文檔歷史

• 版本 1.0：初始發佈，包含基本命令和文件操作功能。
• 版本 2.0：引入了目錄限制和增強的安全機制。
• 版本 3.0：支持腳本執行和高級文件管理功能。

如需更多信息，請參考 STeLA MCP 官方文檔。