README
🚀 CMD MCP 服务器
本项目是一个 Model Context Protocol (MCP) 服务器实现,可在 Windows 和 Linux 系统上执行 CMD 命令,还支持 SSH 连接。它能将命令行操作与 MCP 兼容的应用程序集成,为相关操作带来便利。
✨ 主要特性
- 可通过 MCP 执行 CMD 命令。
- 采用 TypeScript 实现。
- 基于官方 MCP SDK 构建。
- 具备跨平台兼容性。
📦 安装指南
使用 Smithery 安装
若要通过 Smithery 自动安装 CMD 服务器,可执行以下命令:
npx -y @smithery/cli install server-cmd --client claude
手动安装
使用以下命令手动安装:
npm install server-cmd
先决条件
- Node.js(建议版本 v16 或更高)
- npm 或 yarn 包管理器
💻 使用示例
基础用法
import { MCPCmdServer } from 'server-cmd';
// 初始化服务器
const 服务器 = new MCPCmdServer();
// 启动服务器
服务器.start();
高级用法
服务器可通过环境变量或配置对象进行配置:
const config = {
// 在这里添加您的配置选项
};
const 服务器 = new MCPCmdServer(config);
📚 详细文档
开发环境搭建
若要设置开发环境,可按以下步骤操作:
- 克隆仓库:
git clone https://github.com/PhialsBasement/CMD-MCP-Server.git
cd CMD-MCP-Server
- 安装依赖项:
npm install
- 构建项目:
npm run build
脚本说明
npm run build- 将 TypeScript 编译为 JavaScriptnpm run prepare- 为发布准备包
依赖项
@modelcontextprotocol/sdk: ^1.0.1glob: ^10.3.10zod-to-json-schema: ^3.23.5
🤝 贡献
欢迎大家贡献代码!请随意提交 Pull Request。
📄 许可证
该项目根据 MIT License 发布,详情请参阅 LICENSE 文件。
⚠️ 重要提示
执行命令行操作可能具有潜在危险。在生产环境中使用此服务器时,请确保实施适当的安全措施。
Scan to join WeChat group