article
README
🚀 终端控制器 for MCP
终端控制器 for MCP 是一个模型上下文协议(MCP)服务器,它借助标准接口,实现了安全的终端命令执行、目录导航以及文件系统操作,为用户提供便捷、安全的操作体验。
✨ 主要特性
- 命令执行:可运行带超时控制的终端命令,并提供全面的结果反馈。
- 目录导航:能轻松地浏览和操作文件系统结构。
- 文件系统操作:可对文件和目录进行高效管理。
- 实时输出:运行系统命令时,能获取实时输出和结果。
- 丰富的文件操作:支持读取、写入、插入、更新和删除等文件操作功能。
- 目录管理:可浏览目录结构,并执行基本的文件管理操作。
- 安全机制:内置黑名单机制,有效防止危险命令执行。
📦 安装指南
通过 Smithery 安装
# 安装 Terminal Controller for MCP
# 配置 MCP 环境
# 启动服务
使用 Python 包安装
pip install terminal-controller-mcp
💻 使用示例
客户端配置
MCP 客户端配置示例
# 示例配置文件
{
"server_address": "localhost",
"port": 5000,
"timeout": 3600
}
命令行使用示例
基础用法
# 运行终端控制器服务
python -m terminal_controller
高级用法
# 或者使用 uvx 工具:
uvx terminal_controller
⚠️ 安全注意事项
- 所有命令执行都设有超时控制,默认为 3600 秒。
- 禁止使用危险命令,如
rm -rf /、format和mkfs。 - 操作结果会被详细记录和审计。
🚫 限制与不足
- 命令仅在超时时间内返回结果。
- 默认情况下,服务器拥有与当前用户相同的文件系统权限。
- 部分交互式命令可能无法正常工作,因为它们依赖于交互界面。
🛠️ 故障排除
- 确保 Python 版本为 3.11 或更高。
- 检查 MCP 客户端配置是否正确。
- 直接运行终端控制器检查是否有错误:
python -m terminal_controller - 对于 uvx 相关问题,尝试:
uvx terminal_controller
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
MIT
微信扫一扫