article
README
🚀 终端 MCP 服务器
终端 MCP 服务器是一个借助 Claude Desktop 来执行终端命令的模型上下文协议(MCP)服务器。它能让用户在特定环境下方便地执行各类终端操作,提升工作效率。
✨ 主要特性
- 可执行带有参数和选项的任何终端命令,满足多样化的操作需求。
- 能在保持状态的同时在目录之间切换,便于连续操作。
- 可以获取终端环境信息,帮助用户了解当前操作环境。
- 能够捕获完整的输出(stdout, stderr, 退出码),方便进行后续分析。
- 具备正确的错误处理和格式化机制,保障操作的稳定性。
📦 安装指南
先决条件
- Node.js v18 或更高版本
- TypeScript
- Claude Desktop
安装步骤
- 克隆仓库:
git clone https://github.com/stat-guy/terminal.git
cd terminal
- 安装依赖项:
npm install
- 构建项目:
npm run build
📚 详细文档
本地开发环境设置
- 创建或编辑您的 Claude Desktop 配置文件:
- 在 macOS 上:
~/Library/Application Support/Claude/claude_desktop_config.json - 在 Windows 上:
%APPDATA%\\Claude\\claude_desktop_config.json
- 在 macOS 上:
添加以下配置:
{
"mcpServers": {
"terminal": {
"command": "node",
"args": [
"[PATH_TO_REPO]/dist/index.js"
],
"env": {
"PERMISSION_REQUIRED": "true"
}
}
}
}
将 [PATH_TO_REPO] 替换为您实际克隆的仓库路径。
- 重新启动 Claude Desktop
可用工具
execute_command
- 执行任何终端命令
- 支持带有参数和选项的命令
- 捕获完整的输出和退出码
change_directory
- 更改当前工作目录
- 在命令之间保持状态
- 支持相对路径和绝对路径
get_current_directory
- 获取当前工作目录路径
get_terminal_info
- 获取终端环境信息
- 显示壳层、用户、平台和最近的命令历史记录
安全注意事项
- 该服务器需要通过 Claude Desktop 显式用户权限进行命令执行
- 环境变量可以通过配置控制
- 命令执行包括超时和错误处理
开发
- 监视更改:
npm run watch
- 测试更改:
- 修改
src/中的源文件 - 使用
npm run build重建 - 重新启动 Claude Desktop 以加载更改
💻 使用示例
基础用法
让 Claude 执行终端命令,例如:
你能检查我的当前目录中有何文件吗?
-> 执行:ls -la
你能告诉我当前目录是什么?
-> 执行:pwd
你能切换到下载文件夹吗?
-> 执行:cd ~/Downloads
Scan to join WeChat group