使用说明

项目简介

'cmd-line-executor-MCP' 是一个基于 Model Context Protocol (MCP) 的服务器实现，它为大型语言模型 (LLM) 客户端提供执行本地命令行命令的功能。通过集成此服务器，LLM 能够调用操作系统级别的命令，并获取执行结果，从而扩展其能力，例如进行系统管理、数据处理或调用外部工具。

主要功能点

命令行命令执行: 提供 'run_command' 工具，允许 LLM 客户端指定要执行的命令行命令及其参数。
结果返回: 执行命令后，服务器会将命令的标准输出 (stdout)、标准错误输出 (stderr) 以及返回状态码以 JSON 格式返回给 LLM 客户端。
标准MCP协议: 遵循 MCP 协议标准，通过 JSON-RPC 协议与客户端通信，易于集成到支持 MCP 协议的 LLM 应用中。
配置灵活: 支持通过简单的 JSON 配置集成到 MCP 客户端，例如 Claude Desktop。

安装步骤

该项目本身是一个 Python 包，无需复杂的安装步骤。您只需要确保您的环境中安装了 Python 和 'uv' 包管理器 (根据仓库 'README.md' 推荐使用)。

克隆仓库 (如果需要修改或深入了解代码):

git clone https://github.com/MCP-Mirror/MarkusPfundstein_cmd-line-executor-MCP.git
cd MarkusPfundstein_cmd-line-executor-MCP

安装依赖 (根据 'README.md'，推荐使用 'uv'):
```
uv sync
```
或者使用 'pip':
```
pip install .
```

服务器配置

要将 'cmd-line-executor' 服务器连接到 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件中添加服务器配置信息。以下是配置示例，通常位于客户端的配置文件中（例如 Claude Desktop 的 'claude_desktop_config.json'）：

开发/未发布服务器配置示例:

"mcpServers": {
  "cmd-line-executor": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/cmd-line-executor",  //  请替换为 cmd-line-executor 项目的实际路径
      "run",
      "cmd-line-executor"
    ]
  }
}

注意: 请将 '/path/to/cmd-line-executor' 替换为您克隆或存放 'cmd-line-executor-MCP' 项目的实际本地路径。

发布服务器配置示例:

"mcpServers": {
  "cmd-line-executor": {
    "command": "uvx",
    "args": [
      "cmd-line-executor"
    ]
  }
}

注意: "发布服务器配置" 适用于已构建和打包的项目，可能需要先执行构建和发布步骤（参考仓库 'README.md'）。

基本使用方法

启动服务器: 根据您的配置方式，MCP 客户端会在需要时自动启动 'cmd-line-executor' 服务器。
调用工具: 在 LLM 客户端的交互中，当 LLM 需要执行命令行命令时，它会调用 'run_command' 工具。
指定命令和参数: LLM 客户端需要提供 'cmd' 参数（要执行的命令，例如 'ls', 'pwd', 'python' 等）和可选的 'args' 参数（命令的参数，例如 '-l', '.' , 'script.py' 等）。
获取结果: 服务器执行命令后，会将包含 'stdout' (标准输出), 'stderr' (标准错误输出), 'status_code' (状态码) 的 JSON 响应返回给 LLM 客户端。LLM 可以根据这些信息进行后续处理或生成回复。

示例: 如果 LLM 客户端调用 'run_command' 工具，并传入参数 '{"cmd": "ls", "args": "-l"}'，服务器将执行 'ls -l' 命令，并将结果返回给 LLM。

关键词