article
README
🚀 Nash MCP 服务器
Nash MCP(模型上下文协议 (MCP) 服务器)无缝集成了命令执行、Python 代码运行、网络内容获取和任务管理等功能,为用户提供高效便捷的操作体验。
🚀 快速开始
安装要求
- Python 3.11+
- Poetry 包管理器(推荐)
安装步骤
git clone https://github.com/nash-run/nash-mcp.git
cd nash-mcp
poetry install
✨ 主要特性
- 命令执行:运行 shell 命令并处理错误。
- Python 执行:运行 Python 代码并捕获错误。
- 安全凭证:存储和访问 API 密钥,避免敏感数据泄露给大语言模型 (LLM)。
- 网络内容获取:抓取并解析网页内容进行分析。
- 任务管理:保存和整理可复用的任务。
📦 安装指南
环境变量配置
以下环境变量需在运行时指定: | 属性 | 详情 | |------|------| | NASH_LOGS_PATH | 指定日志文件的存储路径 | | NASH_TASK_DIR | 定义任务文件的存放位置 |
💻 使用示例
工具模块
命令执行
execute_command(command: str) -> str
参数:command - 要运行的 shell 命令
返回值:命令输出或错误信息
Python 执行
execute_python(code: str, file_name: str = "") -> str
参数:
code: 待执行的 Python 代码片段file_name(可选): 存放代码文件的名称,默认为空字符串
📚 详细文档
常见注意事项
⚠️ 重要提示
- 所有 API 密钥需通过环境变量加载,避免硬编码。
- 所有操作和工具执行的日志均记录在指定目录下,便于后续排查问题。
- 建议定期审查服务器代码和配置文件,确保无未授权访问风险。
开发指南
日志系统
详细的按时间戳记录的操作日志存储于 NASH_LOGS_PATH 指定的目录中,内容涵盖所有操作及工具执行情况。
测试框架
poetry run pytest
带代码覆盖率测试:
poetry run pytest --cov=nash_mcp
📄 许可证
MIT License
微信扫一扫