# deployment-mcp

An MCP (Model Context Protocol) server that handles deployment operations over SSH.

## Features

- **`ssh_git_pull`** – SSH into a remote host and run `git pull` in a specified repository directory.
- **`ssh_run_command`** – Execute an arbitrary shell command on a remote host and return its stdout, stderr and exit code.
- **`ssh_run_script`** – Upload and execute a multi-line shell script on a remote host (piped to bash; no temporary files created locally).
- **`write_ssh_config`** – Write or update a `Host` entry in the local `~/.ssh/config` file.

All SSH tools support authentication via an **inline PEM private key**, a **path to a key file**, or a **password**.

## Installation

```bash
npm install
npm run build
```

## Usage

Run the MCP server over stdio (used by MCP-compatible AI clients):

```bash
node dist/index.js
```

### MCP client configuration example

```json
{
  "mcpServers": {
    "deployment": {
      "command": "node",
      "args": ["/path/to/deployment-mcp/dist/index.js"]
    }
  }
}
```

### Tool examples

#### `ssh_git_pull`

```json
{
  "host": "my-server.example.com",
  "username": "deploy",
  "privateKeyPath": "~/.ssh/id_rsa",
  "repoPath": "/var/www/myapp",
  "branch": "main"
}
```

#### `ssh_run_command`

```json
{
  "host": "my-server.example.com",
  "username": "deploy",
  "privateKeyPath": "~/.ssh/id_rsa",
  "command": "systemctl restart myapp"
}
```

#### `ssh_run_script`

```json
{
  "host": "my-server.example.com",
  "username": "deploy",
  "privateKeyPath": "~/.ssh/id_rsa",
  "workingDirectory": "/var/www/myapp",
  "script": "#!/bin/bash\nset -e\ngit pull\nnpm install --omit=dev\nnpm run build\npm2 restart myapp"
}
```

#### `write_ssh_config`

```json
{
  "alias": "my-server",
  "hostname": "my-server.example.com",
  "user": "deploy",
  "identityFile": "~/.ssh/deploy_key",
  "extraOptions": {
    "StrictHostKeyChecking": "no",
    "ServerAliveInterval": "60"
  }
}
```

## Development

```bash
npm run dev    # TypeScript watch mode
npm test       # Run tests
npm run build  # Compile TypeScript
```