Bash MCP (主控程序)

一个 TypeScript 应用程序，允许 Claude 安全地执行带有安全保障的 bash 命令。本项目实现了模型上下文协议 (MCP)，为从 Claude 等 AI 助手执行 bash 命令提供了一个安全接口。

特性

• 在受控环境中执行 bash 命令
• 支持无状态和有状态（交互式）命令执行
• 安全保障：
  • 白名单命令
  • 白名单目录
  • 命令验证
  • 输出清理
• 交互式命令的会话管理
• 综合日志记录
• 用于 AI 集成的 MCP 服务器实现

安装

npm install
npm run build

配置

配置存储在 config/default.json 中。您可以自定义：

• 允许的命令
• 允许的目录
• 会话设置
• 安全设置
• 日志设置

配置示例：

{
  "allowedCommands": ["ls", "cat", "echo", "pwd"],
  "allowedDirectories": ["/tmp", "/home"],
  "session": {
    "timeout": 300,
    "maxActiveSessions": 5,
    "defaultMode": "stateless"
  },
  "security": {
    "validateCommandsStrictly": true,
    "sanitizeOutput": true,
    "maxOutputSize": 1048576,
    "commandTimeout": 30
  },
  "logging": {
    "level": "info",
    "file": "logs/bash-mcp.log",
    "maxSize": 10485760,
    "maxFiles": 5
  }
}

用法

作为库

简单命令执行

import { executeCommand } from 'bash-mcp';

const result = await executeCommand('ls -la', { cwd: '/home/user' });
console.log(result.output);

交互式会话

import { initBashMCP } from 'bash-mcp';

const mcp = await initBashMCP();

// 创建一个会话
const session = mcp.createSession('/home/user');
const sessionId = session.sessionId;

// 在会话中执行命令
const result1 = await mcp.executeCommand('ls -la', { sessionId });
console.log(result1.output);

// 向会话发送输入
const result2 = await mcp.sendInput({ sessionId, input: 'echo "Hello, world!"' });
console.log(result2.output);

// 完成后关闭会话
mcp.closeSession(sessionId);

作为 MCP 服务器

本项目包含一个 MCP 服务器实现，可以与 Claude Desktop 或其他 MCP 客户端一起使用：

# 启动 TypeScript MCP 服务器
npm run mcp

# 启动 JavaScript MCP 服务器
npm run mcp-js

# 使用 MCP Inspector 启动
npm run inspector

有关 MCP 服务器实现的详细文档，请参阅 MCP.md。

安全注意事项

此 MCP 在设计时考虑了安全性，但重要的是：

• 尽可能限制允许的命令和目录列表
• 定期审查和更新配置
• 监控日志以查找可疑活动
• 保持 MCP 及其依赖项为最新

开发

构建

npm run build

代码检查和格式化

要检查代码检查问题：

npm run lint

要自动修复代码检查和格式化问题：

./fix-lint.sh

或者手动：

npm run lint:fix  # 修复代码检查问题
npm run format    # 格式化代码

测试

npm test

MCP SDK 版本

本项目使用 MCP SDK 版本 1.0.1。