终端命令执行服务器

一个提供终端命令执行和文件系统管理功能的RESTful API服务器,适用于AI助手。

  • by neoforge-dev
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 neoforge-dev/neoforge-mcp-server

使用说明

终端命令运行程序MCP服务器

一个强大的模型控制协议(MCP)服务器,通过RESTful API接口为人工智能助手提供终端命令执行和文件系统管理功能。

🌟 特性

终端管理

  • 执行具有可配置超时的命令
  • 在后台管理长时间运行的流程
  • 从活动命令会话中获取输出
  • 列出所有活动会话和系统进程
  • 终止或终止进程
  • 安全命令黑名单

文件系统操作

  • 读取和写入文件
  • 创建目录
  • 列出目录内容
  • 移动/重命名文件
  • 使用glob模式搜索文件
  • 获取详细的文件信息

高级功能

  • 通过搜索和替换进行精确的文本编辑
  • 系统信息检索
  • 数学表达式评估

🚀 快速开始

先决条件

  • Python 3.13+
  • 紫外线 包管理器(推荐)

安装

  1. 克隆存储库:
git clone https://github.com/neoforge-dev/neoforge-mcp-server.git
cd python-server-mcp
  1. 创建虚拟环境并安装依赖项:
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e .
  1. 启动MCP服务器:
python server.py

服务器将于启动http://0.0.0.0:8000.

🧪 测试

该项目包括一个全面的测试套件,用于验证功能:

# Install test dependencies
uv pip install -r requirements.txt

# Run all tests
./run_tests.py

# Run tests with coverage report
./run_tests.py --coverage

# Run tests with verbose output
./run_tests.py --verbose

# Run specific test file
./run_tests.py --test tests/test_command_execution.py

测试套件包括:

  • 命令执行和流程管理
  • 文件系统操作
  • 系统实用程序
  • 安全功能

🔧 配置

通过将Cursor添加到您的 ~/.cursor/mcp.json 文件:

{
  "mcpServers": {
    "NeoMCP": {
      "command": "/path/to/uv",
      "args": [
        "run",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "/path/to/python-server-mcp/server.py"
      ]
    }
  }
}

📖 api参考

终端工具

  • execute_command:运行具有可配置超时的命令
  • read_output:从正在运行的进程中获取输出
  • force_terminate:停止正在运行的命令
  • list_sessions:显示所有活动的命令会话
  • list_processes:查看所有系统进程
  • kill_process:通过PID终止进程
  • block_command:将命令添加到黑名单
  • unblock_command:从黑名单中删除命令

文件系统工具

  • read_file:读取文件内容
  • write_file:将数据写入文件
  • create_directory:创建新目录
  • list_directory:列出目录的内容
  • move_file:移动或重命名文件和目录
  • search_files:查找与图案匹配的文件
  • get_file_info:获取详细的文件信息

编辑工具

  • edit_block:使用类似diff的语法应用精确的文本替换

系统工具

  • system_info (资源):获取详细的系统信息
  • calculate:计算数学表达式

🔒 安全考虑

  • 服务器实现命令黑名单以防止危险命令
  • 读取操作的文件大小限制
  • 表达评估保障措施
  • 默认命令安全检查

🤝 贡献

欢迎投稿!请随时提交拉取请求。

📄 许可证

此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。