Skip to main content

A Model Context Protocol server providing shell command execution capabilities for LLMs

Project description

Shell MCP Server

A Model Context Protocol server that provides shell command execution capabilities. This server enables LLMs to execute shell commands and receive their output in a controlled manner.

Available Tools

  • execute_command - Execute a shell command and return its output
    • Required arguments:
      • command (string): Shell command to execute
    • Returns:
      • Command result containing:
        • command: The executed command
        • output: Combined stdout and stderr output
        • return_code: Command execution return code

Installation

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-shell.

Using PIP

Alternatively you can install mcp-server-shell via pip:

pip install mcp-server-shell

After installation, you can run it as a script using:

python -m mcp_server_shell

Configuration

Configure for Claude.app

Add to your Claude settings:

Using uvx
"mcpServers": {
  "shell": {
    "command": "uvx",
    "args": ["mcp-server-shell"]
  }
}
Using pip installation
"mcpServers": {
  "shell": {
    "command": "python",
    "args": ["-m", "mcp_server_shell"]
  }
}

Configure for Zed

Add to your Zed settings.json:

Using uvx
"context_servers": {
  "mcp-server-shell": {
    "command": "uvx",
    "args": ["mcp-server-shell"]
  }
},
Using pip installation
"context_servers": {
  "mcp-server-shell": {
    "command": "python",
    "args": ["-m", "mcp_server_shell"]
  }
},

Example Interactions

Execute a shell command:

{
  "name": "execute_command",
  "arguments": {
    "command": "ls -la"
  }
}

Response:

{
  "command": "ls -la",
  "output": "total 24\ndrwxr-xr-x  5 user  group   160 Jan  1 12:00 .\ndrwxr-xr-x  3 user  group    96 Jan  1 12:00 ..",
  "return_code": 0
}

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx mcp-server-shell

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/servers/src/shell
npx @modelcontextprotocol/inspector uv run mcp-server-shell

Examples of Questions for Claude

  1. "What files are in the current directory?"
  2. "Show me the contents of the README.md file"
  3. "What's the current system date?"
  4. "Check if Python is installed and show its version"

Security Considerations

⚠️ Warning: This server executes shell commands directly on your system. Use with caution and implement appropriate security measures to prevent unauthorized or dangerous command execution.

Contributing

We encourage contributions to help expand and improve mcp-server-shell. Whether you want to add new features, enhance security, or improve documentation, your input is valuable.

For examples of other MCP servers and implementation patterns, see: https://github.com/modelcontextprotocol/servers

Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-shell even more powerful and useful.

License

mcp-server-shell is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

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

mcp_server_shell-0.1.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

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

mcp_server_shell-0.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_shell-0.1.0.tar.gz.

File metadata

  • Download URL: mcp_server_shell-0.1.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.5

File hashes

Hashes for mcp_server_shell-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b00ccba3c442ca93aed36f3625eb860d665fd46c7fd1960e6c98a636a4fbcb6a
MD5 e4f3772037b7ddca4d322165884a2646
BLAKE2b-256 3832feec56cb1654bb4fda83aae985fa8bbd5840598381d615aaf0a6d61eeca7

See more details on using hashes here.

File details

Details for the file mcp_server_shell-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_shell-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f52bec43f70ba0d128fee3af5f1061c0427dfa2abbe30a61c36a78f1fbc37a0a
MD5 b42e45a621f21ce4109387b0ffbb94a3
BLAKE2b-256 c3c0e208b4e1c6ca8c04a7038fd160e0e44c8395800c1c970433ba437cf74fb3

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