| Name | mcp-server-shell JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A Model Context Protocol server providing shell command execution capabilities for LLMs |
| upload_time | 2024-12-12 00:09:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
command
llm
mcp
shell
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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`](https://docs.astral.sh/uv/) no specific installation is needed. We will
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-shell*.
### Using PIP
Alternatively you can install `mcp-server-shell` via pip:
```bash
pip install mcp-server-shell
```
After installation, you can run it as a script using:
```bash
python -m mcp_server_shell
```
## Configuration
### Configure for Claude.app
Add to your Claude settings:
<details>
<summary>Using uvx</summary>
```json
"mcpServers": {
"shell": {
"command": "uvx",
"args": ["mcp-server-shell"]
}
}
```
</details>
<details>
<summary>Using pip installation</summary>
```json
"mcpServers": {
"shell": {
"command": "python",
"args": ["-m", "mcp_server_shell"]
}
}
```
</details>
### Configure for Zed
Add to your Zed settings.json:
<details>
<summary>Using uvx</summary>
```json
"context_servers": {
"mcp-server-shell": {
"command": "uvx",
"args": ["mcp-server-shell"]
}
},
```
</details>
<details>
<summary>Using pip installation</summary>
```json
"context_servers": {
"mcp-server-shell": {
"command": "python",
"args": ["-m", "mcp_server_shell"]
}
},
```
</details>
## Example Interactions
Execute a shell command:
```json
{
"name": "execute_command",
"arguments": {
"command": "ls -la"
}
}
```
Response:
```json
{
"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:
```bash
npx @modelcontextprotocol/inspector uvx mcp-server-shell
```
Or if you've installed the package in a specific directory or are developing on it:
```bash
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "mcp-server-shell",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "command, llm, mcp, shell",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/38/32/feec56cb1654bb4fda83aae985fa8bbd5840598381d615aaf0a6d61eeca7/mcp_server_shell-0.1.0.tar.gz",
"platform": null,
"description": "# Shell MCP Server\n\nA 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.\n\n## Available Tools\n\n- `execute_command` - Execute a shell command and return its output\n - Required arguments:\n - `command` (string): Shell command to execute\n - Returns:\n - Command result containing:\n - `command`: The executed command\n - `output`: Combined stdout and stderr output\n - `return_code`: Command execution return code\n\n## Installation\n\n### Using uv (recommended)\n\nWhen using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will\nuse [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-shell*.\n\n### Using PIP\n\nAlternatively you can install `mcp-server-shell` via pip:\n\n```bash\npip install mcp-server-shell\n```\n\nAfter installation, you can run it as a script using:\n\n```bash\npython -m mcp_server_shell\n```\n\n## Configuration\n\n### Configure for Claude.app\n\nAdd to your Claude settings:\n\n<details>\n<summary>Using uvx</summary>\n\n```json\n\"mcpServers\": {\n \"shell\": {\n \"command\": \"uvx\",\n \"args\": [\"mcp-server-shell\"]\n }\n}\n```\n</details>\n\n<details>\n<summary>Using pip installation</summary>\n\n```json\n\"mcpServers\": {\n \"shell\": {\n \"command\": \"python\",\n \"args\": [\"-m\", \"mcp_server_shell\"]\n }\n}\n```\n</details>\n\n### Configure for Zed\n\nAdd to your Zed settings.json:\n\n<details>\n<summary>Using uvx</summary>\n\n```json\n\"context_servers\": {\n \"mcp-server-shell\": {\n \"command\": \"uvx\",\n \"args\": [\"mcp-server-shell\"]\n }\n},\n```\n</details>\n\n<details>\n<summary>Using pip installation</summary>\n\n```json\n\"context_servers\": {\n \"mcp-server-shell\": {\n \"command\": \"python\",\n \"args\": [\"-m\", \"mcp_server_shell\"]\n }\n},\n```\n</details>\n\n## Example Interactions\n\nExecute a shell command:\n```json\n{\n \"name\": \"execute_command\",\n \"arguments\": {\n \"command\": \"ls -la\"\n }\n}\n```\nResponse:\n```json\n{\n \"command\": \"ls -la\",\n \"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 ..\",\n \"return_code\": 0\n}\n```\n\n## Debugging\n\nYou can use the MCP inspector to debug the server. For uvx installations:\n\n```bash\nnpx @modelcontextprotocol/inspector uvx mcp-server-shell\n```\n\nOr if you've installed the package in a specific directory or are developing on it:\n\n```bash\ncd path/to/servers/src/shell\nnpx @modelcontextprotocol/inspector uv run mcp-server-shell\n```\n\n## Examples of Questions for Claude\n\n1. \"What files are in the current directory?\"\n2. \"Show me the contents of the README.md file\"\n3. \"What's the current system date?\"\n4. \"Check if Python is installed and show its version\"\n\n## Security Considerations\n\n\u26a0\ufe0f **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.\n\n## Contributing\n\nWe 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.\n\nFor examples of other MCP servers and implementation patterns, see:\nhttps://github.com/modelcontextprotocol/servers\n\nPull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-server-shell even more powerful and useful.\n\n## License\n\nmcp-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.",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Model Context Protocol server providing shell command execution capabilities for LLMs",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"command",
" llm",
" mcp",
" shell"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3c0e208b4e1c6ca8c04a7038fd160e0e44c8395800c1c970433ba437cf74fb3",
"md5": "b42e45a621f21ce4109387b0ffbb94a3",
"sha256": "f52bec43f70ba0d128fee3af5f1061c0427dfa2abbe30a61c36a78f1fbc37a0a"
},
"downloads": -1,
"filename": "mcp_server_shell-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b42e45a621f21ce4109387b0ffbb94a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4742,
"upload_time": "2024-12-12T00:09:07",
"upload_time_iso_8601": "2024-12-12T00:09:07.680221Z",
"url": "https://files.pythonhosted.org/packages/c3/c0/e208b4e1c6ca8c04a7038fd160e0e44c8395800c1c970433ba437cf74fb3/mcp_server_shell-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3832feec56cb1654bb4fda83aae985fa8bbd5840598381d615aaf0a6d61eeca7",
"md5": "e4f3772037b7ddca4d322165884a2646",
"sha256": "b00ccba3c442ca93aed36f3625eb860d665fd46c7fd1960e6c98a636a4fbcb6a"
},
"downloads": -1,
"filename": "mcp_server_shell-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e4f3772037b7ddca4d322165884a2646",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20534,
"upload_time": "2024-12-12T00:09:09",
"upload_time_iso_8601": "2024-12-12T00:09:09.972841Z",
"url": "https://files.pythonhosted.org/packages/38/32/feec56cb1654bb4fda83aae985fa8bbd5840598381d615aaf0a6d61eeca7/mcp_server_shell-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 00:09:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcp-server-shell"
}
