README
🚀 Shell MCP 服务器
Shell MCP 服务器是一个基于模型上下文协议(Model Context Protocol)的服务器,它提供了 shell 命令执行功能。该服务器能够让大型语言模型安全地执行 shell 命令,并接收命令的输出结果。
✨ 主要特性
- 提供
execute_command工具,可执行 shell 命令并返回输出。 - 支持多种安装方式,如使用
uv或pip进行安装。 - 可针对不同应用(Claude.app、Zed)进行配置。
- 提供示例交互和调试方法。
📦 安装指南
使用 uv(推荐)
当使用uv时,无需进行特定安装。我们将直接使用uvx运行 mcp-server-shell。
使用 pip 安装
或者,您可以通过 pip 安装 mcp-server-shell:
pip install mcp-server-shell
安装完成后,可以作为脚本运行:
python -m mcp_server_shell
📚 详细文档
配置指南
配置用于 Claude.app
在您的 Claude 设置中添加:
使用 uvx
"mcpServers": {
"shell": {
"command": "uvx",
"args": ["mcp-server-shell"]
}
}
使用 pip 安装
"mcpServers": {
"shell": {
"command": "python",
"args": ["-m", "mcp_server_shell"]
}
}
配置用于 Zed
在您的 Zed settings.json 中添加:
使用 uvx
"context_servers": {
"mcp-server-shell": {
"command": "uvx",
"args": ["mcp-server-shell"]
}
},
使用 pip 安装
"context_servers": {
"mcp-server-shell": {
"command": "python",
"args": ["-m", "mcp_server_shell"]
}
},
可用工具
execute_command- 执行 shell 命令并返回其输出- 必要参数:
command(字符串):待执行的 shell 命令
- 返回内容:
command:执行的命令output:合并后的 stdout 和 stderr 输出return_code:命令执行返回码
- 必要参数:
示例交互
执行 shell 命令
{
"name": "execute_command",
"arguments": {
"command": "ls -la"
}
}
响应
{
"command": "ls -la",
"output": "total 24\ndrwxr-xr-x 5 user group 160 Jan 1 12:00 .\ndrwxr-xr-x 3 user group 96 Jan 1 12:00 ..",
"return_code": 0
}
调试方法
您可以使用 MCP inspector 调试服务器。
对于 uvx 安装
npx @modelcontextprotocol/inspector uvx mcp-server-shell
特定目录安装或开发此包
cd path/to/servers/src/shell
npx @modelcontextprotocol/inspector uv run mcp-server-shell
示例问题(针对 Claude)
- “当前目录下有哪些文件?”
- “显示 README.md 文件的内容”
- “当前系统的日期是什么?”
- “检查 Python 是否已安装并显示其版本”
⚠️ 重要提示
⚠️ 重要提示
此服务器直接在本地执行 shell 命令。请确保输入的命令是可信的,以防止潜在的安全风险。
🤝 贡献指南
如需贡献,请参考项目文档或联系维护人员。
📄 许可证
[此处添加许可证信息]
Scan to join WeChat group