diff --git a/README.md b/README.md index 7205aab..f3aed0d 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,113 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that e ## 🚀 Installation -### For Claude Code users +RemoteShell is a stdio MCP server distributed on PyPI. Run it directly with [`uvx`](https://docs.astral.sh/uv/) — no install step required, just make sure [uv](https://github.com/astral-sh/uv) is installed: + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +Then register the server with your AI coding agent. Click yours to expand 👇 + +
+Claude Code (recommended) + ```bash claude mcp add remoteshell --scope user -- uvx remoteshell-mcp ``` -### For other MCP clients +
+ +
+Codex (OpenAI Codex CLI) + +```bash +codex mcp add remoteshell -- uvx remoteshell-mcp +``` + +
+ +
+Cursor + +```bash +cursor mcp add remoteshell -- uvx remoteshell-mcp +``` + +
+ +
+Antigravity + +Edit `~/.gemini/config/mcp_config.json` (global) or `.agents/mcp_config.json` (project): + +```json +{ + "mcpServers": { + "remoteshell": { + "command": "uvx", + "args": ["remoteshell-mcp"] + } + } +} +``` + +Or open the **MCP Servers** view in the Antigravity TUI and run the `/mcp` command. + +
+ +
+OpenCode + +```bash +opencode mcp add +``` + +Choose **local**, then enter `uvx remoteshell-mcp`. + +
+ +
+Hermes Agent (NousResearch) + +Edit `~/.hermes/config.yaml`: + +```yaml +mcp_servers: + remoteshell: + command: "uvx" + args: ["remoteshell-mcp"] +``` + +Run `/reload-mcp` in the Hermes TUI to pick up the new server. + +
+ +
+OpenClaw + +Edit `~/.openclaw/openclaw.json`: + +```json +{ + "mcp": { + "servers": { + "remoteshell": { + "command": "uvx", + "args": ["remoteshell-mcp"] + } + } + } +} +``` + +Or run `openclaw configure` to add it via the interactive wizard. + +
+ +
+Other MCP clients + Add this to your MCP client configuration: ```json @@ -29,6 +130,9 @@ Add this to your MCP client configuration: } } ``` + +
+ ## 📖 Usage Getting started is easy! You can either: