https://github.com/mkusaka/mcp-shell-server
https://github.com/mkusaka/mcp-shell-server
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mkusaka/mcp-shell-server
- Owner: mkusaka
- License: mit
- Created: 2025-03-20T12:27:21.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-28T17:22:13.000Z (3 months ago)
- Last Synced: 2025-03-28T18:28:24.923Z (3 months ago)
- Language: TypeScript
- Size: 69.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - Shell Command Executor - Execute shell commands through AI agents with multi-shell support and detailed error handling. Integrates command execution directly into applications for enhanced workflow efficiency. (APIs and HTTP Requests)
README
# MCP Shell Server
A server that uses the Model Context Protocol (MCP) to execute shell commands. It functions as a bridge that allows AI agents to safely execute shell commands.
## Features
- Execute shell commands (single-line and multi-line support)
- Support for various shells (bash, zsh, fish, powershell, cmd, etc.)
- Detailed error handling and logging
- MCP Inspector compatible
## Installation
### From npm (as a user)
```bash
# Using npm
npm install -g @mkusaka/mcp-shell-server
# Using yarn
yarn global add @mkusaka/mcp-shell-server
# Using pnpm
pnpm add -g @mkusaka/mcp-shell-server
```
### From source (for development)
```bash
# Clone the repository
git clone https://github.com/mkusaka/mcp-shell-server.git
cd mcp-shell-server
# Install dependencies
pnpm install
# Build the project
pnpm build
```
## MCP Configuration
### Cursor Configuration
Add the following to your Cursor configuration file (`~/.cursor/config.json`):
```json
{
"mcpServers": {
"shell": {
"command": "npx",
"args": ["-y", "@mkusaka/mcp-shell-server"]
}
}
}
```
### Rule Configuration
Add the following to your Cursor rules file:
```
You have tools at your disposal to solve the coding task. Follow these rules regarding tool calls:
1. ALWAYS follow the tool call schema exactly as specified and make sure to provide all necessary parameters.
2. The conversation may reference tools that are no longer available. NEVER call tools that are not explicitly provided.
3. **NEVER refer to tool names when speaking to the USER.** For example, instead of saying 'I need to use the shell_exec tool to execute your command', just say 'I will execute your command'.
4. Only calls tools when they are necessary. If the USER's task is general or you already know the answer, just respond without calling tools.
5. Before calling each tool, first explain to the USER why you are calling it.
```
## Usage
### Direct Execution
```bash
node dist/index.js
# or as an executable
./dist/index.js
```
### Development Mode
```bash
pnpm dev
```
### Testing with MCP Inspector
```bash
pnpm inspect
```
## Command Line Arguments
```
-s, --shell Specify the path to the shell to use
-h, --help Display help message
-V, --version Display version information
```
## Tool Reference
### shell_exec
Executes commands in the specified shell.
Parameters:
- `command` (string, required): The shell command to execute
## Resource Reference
The server provides the following system information as resources:
### hostname
Returns the hostname of the system.
URI: `hostname://`
### platform
Returns the operating system platform.
URI: `platform://`
### shell
Returns the shell path being used by the server.
URI: `shell://`
### username
Returns the current username.
URI: `username://`
### system-info
Returns comprehensive system information in JSON format, including:
- hostname
- platform
- shell
- username
- CPU count
- Total memory
- Free memory
- System uptime
### Usage Examples
#### Basic Command Execution
```json
{
"name": "shell_exec",
"parameters": {
"command": "echo Hello, World!"
}
}
```
#### Multi-line Command (Heredoc) Execution
```json
{
"name": "shell_exec",
"parameters": {
"command": "cat << EOF | grep 'example'\nThis is an example text.\nAnother line without the keyword.\nEOF"
}
}
```
## Development
### Project Structure
```
src/
├── index.ts # Main entry point
└── shell-server/
├── index.ts # Shell server implementation
└── lib/
└── logger.ts # Logging configuration
```
### Logging
Logs are written to the `mcp-shell.log` file.
## License
MIT