article
README
🚀 Unix 手册服务器 (MCP)
Unix 手册服务器(MCP)可直接在 Claude 对话中提供 Unix 命令文档,帮助用户便捷获取命令相关信息,提升使用效率。
🚀 快速开始
Unix 手册服务器(MCP)是一个强大的工具,能让你在 Claude 对话中轻松获取 Unix 命令文档。以下是使用前的准备步骤。
✨ 主要特性
- 获取命令文档:可检索帮助页面、手册页和命令使用信息,让你全面了解命令详情。
- 列出常用命令:能发现系统上的可用命令,并按功能分类,便于你快速找到所需命令。
- 检查命令是否存在:可验证特定命令是否可用并获得版本信息,避免因命令不存在而导致操作失败。
📦 安装指南
先决条件
- Python 3.13+
- Claude Desktop 或任何与 MCP 兼容的客户端
设置
- 克隆此仓库。
- 安装包:
pip install -e .
# 或者
uv install -e .
- 在 Claude Desktop 中安装服务器:
mcp install unix_manual_server.py
# uv 方式
uv run mcp install unix_manual_server.py
💻 使用示例
基础用法
一旦安装完成,您可以直接在 Claude 中使用服务器的工具。以下是一些常见操作示例:
获取命令文档
我需要帮助使用 grep 命令。你能显示相关文档吗?
列出常用命令
我的系统上有哪些可用的 Unix 命令?
检查命令是否存在
awk 命令在我的系统上可用吗?
高级用法
为了在不安装到 Claude 的情况下本地测试服务器:
mcp dev unix_manual_server.py
🔧 技术细节
安全性
该服务器通过以下方式预防命令注入:
- 对命令名称进行正则表达式验证。
- 直接执行命令而不使用 shell。
- 在所有命令执行上设置超时。
- 仅检查文档,从不执行任意命令。
日志记录
日志保存到与脚本相同目录的 unix-manual-server.log 文件中,方便调试。
- 使用
@modelcontextprotocol/inspector搭配npx在底层:
uv run mcp dev unix_manual_server.py
npx @modelcontextprotocol/inspector uv run unix_manual_server.py
📄 许可证
本项目采用 MIT 许可证。
使用 MCP Python SDK 创建。有关 MCP 的更多信息,请访问 modelcontextprotocol.io。
微信扫一扫