Skip to main content

A MCP server for getting command help manual

Project description

Unix Manual Server (MCP)

An MCP server that provides Unix command documentation directly within Claude conversations.

Features

  • Get command documentation: Retrieve help pages, man pages, and usage information for Unix commands
  • List common commands: Discover available commands on your system, categorized by function
  • Check command existence: Verify if a specific command is available and get its version information

Installation

Prerequisites

Setup

  1. Clone this repository
  2. Install the package:
pip install -e .
# or
uv install -e .
  1. Install the server in Claude Desktop:
mcp install unix_manual_server.py
# uv
uv run mcp install unix_manual_server.py

Usage

Once installed, you can use the server's tools directly in Claude:

Get command documentation

I need help with the grep command. Can you show me the documentation?

List common commands

What Unix commands are available on my system?

Check if a command exists

Is the awk command available on my system?

Development

To test the server locally without installing it in Claude:

mcp dev unix_manual_server.py

Security

The server takes precautions to prevent command injection by:

  • Validating command names against a regex pattern
  • Executing commands directly without using shell
  • Setting timeouts on all command executions
  • Only checking for documentation, never executing arbitrary commands

Logging

Logs are saved to unix-manual-server.log in the same directory as the script, useful for debugging.

  • use @modelcontextprotocol/inspector with npx under the hood.
uv run mcp dev unix_manual_server.py
npx @modelcontextprotocol/inspector uv run unix_manual_server.py

License

MIT


Created with the MCP Python SDK. For more information about MCP, visit modelcontextprotocol.io.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_mcp_unix_manual-1.1.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_mcp_unix_manual-1.1.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file mseep_mcp_unix_manual-1.1.0.tar.gz.

File metadata

  • Download URL: mseep_mcp_unix_manual-1.1.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_mcp_unix_manual-1.1.0.tar.gz
Algorithm Hash digest
SHA256 23f9e169aaa7804c3fc73243925391e3f5e07873ff20da7fd06e192c7dceb1ea
MD5 2e80babd5910ad6dd5bf3b876f455ecd
BLAKE2b-256 43fe6c3e740d770ba2c95312513b0e5e0bd71bbf4a300686320552fa2f8e705f

See more details on using hashes here.

File details

Details for the file mseep_mcp_unix_manual-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_mcp_unix_manual-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c1c5b32176eb24ac1cc6c1bb395735ec0171f8f87305416316982daf334cf79
MD5 4959cb1651970f0a0118c83f442a1810
BLAKE2b-256 d8448b02dae824466a6ffe287a38979ab207bcb1903d480734d98fbf15b13fda

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page