diff --git a/CLAUDE_SETUP.md b/CLAUDE_SETUP.md index d7f84103..ebda34e6 100644 --- a/CLAUDE_SETUP.md +++ b/CLAUDE_SETUP.md @@ -5,7 +5,7 @@ This guide will walk you through connecting the Runloop MCP server to Claude Des ## Prerequisites 1. Make sure you have Claude Desktop installed -2. Authenticate with Runloop: `rli auth` +2. Set your API key: `export RUNLOOP_API_KEY=your_api_key_here` 3. Make sure `rli` is installed globally and in your PATH ## Quick Setup (Automatic) @@ -108,7 +108,7 @@ If not found: ### "API key not configured" -Run `rli auth` to configure your API key before using the MCP server. +Set the `RUNLOOP_API_KEY` environment variable before using the MCP server. ### Claude doesn't show Runloop tools diff --git a/MCP_COMMANDS.md b/MCP_COMMANDS.md index f35f721e..1dc1c43f 100644 --- a/MCP_COMMANDS.md +++ b/MCP_COMMANDS.md @@ -148,7 +148,7 @@ If you get "command not found: rli": ### API key not configured -Run `rli auth` before using the MCP server. +Set the `RUNLOOP_API_KEY` environment variable before using the MCP server. ### Port already in use diff --git a/MCP_README.md b/MCP_README.md index 09e7620a..4aa5c1fe 100644 --- a/MCP_README.md +++ b/MCP_README.md @@ -131,14 +131,12 @@ Example for Claude Code or other MCP clients supporting HTTP: ## Authentication -The MCP server uses the same API key configuration as the CLI. Make sure you've authenticated first: +The MCP server uses the same API key configuration as the CLI. Set your API key: ```bash -rli auth +export RUNLOOP_API_KEY=your_api_key_here ``` -The server will automatically use your stored API credentials. - ## Example Usage with Claude Once configured, you can ask Claude to perform Runloop operations: @@ -162,7 +160,7 @@ Claude will use the MCP tools to interact with your Runloop account and provide If the stdio MCP server isn't working: -1. Make sure you've run `rli auth` to configure your API key +1. Make sure `RUNLOOP_API_KEY` environment variable is set 2. Check that the `rli` command is in your PATH 3. Restart Claude Desktop after updating the configuration 4. Check Claude's logs for any error messages @@ -171,7 +169,7 @@ If the stdio MCP server isn't working: If the HTTP MCP server isn't working: -1. Make sure you've run `rli auth` to configure your API key +1. Make sure `RUNLOOP_API_KEY` environment variable is set 2. Check that the port isn't already in use 3. Verify the server is running: `curl http://localhost:3000/sse` 4. Check your firewall settings if connecting remotely @@ -179,7 +177,7 @@ If the HTTP MCP server isn't working: ### Common Issues -- **"API key not configured"**: Run `rli auth` to set up your credentials +- **"API key not configured"**: Set `RUNLOOP_API_KEY` environment variable - **Port already in use**: Stop other services or use a different port with `--port` - **Connection refused**: Make sure the server is running and accessible diff --git a/OUTPUT_FORMAT_SUMMARY.md b/OUTPUT_FORMAT_SUMMARY.md deleted file mode 100644 index 59d3d4b3..00000000 --- a/OUTPUT_FORMAT_SUMMARY.md +++ /dev/null @@ -1,127 +0,0 @@ -# Output Format Support - Implementation Summary - -All CLI commands now support `-o` or `--output` flags for controlling output format. - -## Supported Formats - -- **`text`** (default): Interactive UI with tables, colors, and navigation -- **`json`**: Non-interactive JSON output for scripting and automation -- **`yaml`**: Non-interactive YAML output for configuration files and readability - -## Reusable Output Utility - -Created `/src/utils/output.ts` with the following functions: - -- `shouldUseNonInteractiveOutput(options)` - Check if non-interactive mode -- `outputList(items, options)` - Output array of items -- `outputResult(result, options)` - Output single result -- `outputError(error, options)` - Handle errors consistently -- `validateOutputFormat(format)` - Validate format option - -## Commands Updated - -### List Commands (with `-o json`) -- ✅ `rli devbox list [-s ] -o json` -- ✅ `rli blueprint list -o json` -- ✅ `rli snapshot list [-d ] -o json` - -### Create Commands (with `-o json`) -- ✅ `rli devbox create [-n ] [-t