run-mcp 1.3.4 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -9
- package/dist/index.js +2262 -298
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -40,6 +40,9 @@ run-mcp repl node path/to/my-mcp-server.js
|
|
|
40
40
|
|
|
41
41
|
# Or use npx without installing globally
|
|
42
42
|
npx . repl node path/to/my-mcp-server.js
|
|
43
|
+
|
|
44
|
+
# Or start it without arguments to open the interactive server discovery menu!
|
|
45
|
+
run-mcp
|
|
43
46
|
```
|
|
44
47
|
|
|
45
48
|
You'll see an interactive prompt:
|
|
@@ -62,6 +65,7 @@ Options:
|
|
|
62
65
|
-o, --out-dir <path> Directory to save intercepted images and audio
|
|
63
66
|
-t, --timeout <ms> Default tool call timeout in milliseconds (default: 300000) (Agent Mode only)
|
|
64
67
|
--max-text <chars> Max text response length before truncation (default: 50000) (Agent Mode only)
|
|
68
|
+
--mcp Force start Agent Server mode even if run interactively without arguments
|
|
65
69
|
-s, --script <file> Read commands from a file instead of stdin (REPL Mode only)
|
|
66
70
|
-h, --help Display help for command
|
|
67
71
|
|
|
@@ -100,16 +104,13 @@ Then use these tools from your agent:
|
|
|
100
104
|
|
|
101
105
|
| Tool | Description |
|
|
102
106
|
|------|-------------|
|
|
103
|
-
| `connect_to_mcp` | Spawn and connect to a local MCP server |
|
|
107
|
+
| `connect_to_mcp` | Spawn and connect to a local MCP server. Use `include` to get tools/resources/prompts inline. Shows a diff on reconnect. |
|
|
104
108
|
| `disconnect_from_mcp` | Tear down the connection |
|
|
105
109
|
| `mcp_server_status` | Check connection status |
|
|
106
|
-
| `
|
|
107
|
-
| `
|
|
108
|
-
| `list_mcp_resources` | List resources |
|
|
109
|
-
| `read_mcp_resource` | Read a resource by URI |
|
|
110
|
-
| `list_mcp_prompts` | List prompts |
|
|
111
|
-
| `get_mcp_prompt` | Get a prompt by name |
|
|
110
|
+
| `call_mcp_primitive` | Call a tool, read a resource, or get a prompt. Auto-connects if not already connected. Use `disconnect_after` for one-shot tests. |
|
|
111
|
+
| `list_mcp_primitives` | List tools, resources, and/or prompts on the connected server |
|
|
112
112
|
| `get_mcp_server_stderr` | View target server stderr output |
|
|
113
|
+
| `list_available_mcp_servers`| Discover other local MCP servers configured on the host machine |
|
|
113
114
|
|
|
114
115
|
## REPL Mode Commands
|
|
115
116
|
|
|
@@ -117,9 +118,11 @@ Once connected via `run-mcp <command>`, the following shorthand commands are ava
|
|
|
117
118
|
|
|
118
119
|
| Command | Description |
|
|
119
120
|
|---------|-------------|
|
|
121
|
+
| `explore` | Open interactive fuzzy-search selector for tools, resources, and prompts |
|
|
120
122
|
| `tools/list` | List all tools exposed by the target server |
|
|
121
123
|
| `tools/describe <name>` | Show a tool's full input schema |
|
|
122
|
-
| `tools/call <name>
|
|
124
|
+
| `tools/call <name> [json] [--clear]` | Call a tool. Launch interactive wizard if no JSON provided. Use `--clear` to ignore remembered arguments. |
|
|
125
|
+
| `tools/forget [name]` | Clear remembered interactive arguments for a tool, or all tools if no name provided. |
|
|
123
126
|
| `status` | Show target server status (PID, uptime, connection) |
|
|
124
127
|
| `help` | Show available commands |
|
|
125
128
|
| `exit` / `quit` | Disconnect and exit |
|
|
@@ -141,6 +144,19 @@ Once connected via `run-mcp <command>`, the following shorthand commands are ava
|
|
|
141
144
|
|
|
142
145
|
# Arguments with spaces work fine
|
|
143
146
|
> tools/call send_message {"text": "hello world", "channel": "general"}
|
|
147
|
+
|
|
148
|
+
### Interactive Wizard & Argument Memory
|
|
149
|
+
|
|
150
|
+
If you invoke a tool without JSON arguments, `run-mcp` will guide you through an interactive scaffolding wizard:
|
|
151
|
+
```bash
|
|
152
|
+
> tools/call send_message
|
|
153
|
+
✔ text (string) Message text to send: Hello World!
|
|
154
|
+
✔ Select optional arguments to provide: channel
|
|
155
|
+
✔ channel (string) The Slack channel: general
|
|
156
|
+
✔ Execute? Yes
|
|
157
|
+
Calling send_message...
|
|
158
|
+
```
|
|
159
|
+
`run-mcp` actively **remembers** your inputs across identical interactive calls, scaffolding defaults based on your last execution! Use `tools/forget` or `--clear` if you need a clean slate.
|
|
144
160
|
```
|
|
145
161
|
|
|
146
162
|
### Script Mode
|
|
@@ -256,4 +272,4 @@ node dist/index.js repl <target_command...>
|
|
|
256
272
|
|
|
257
273
|
## License
|
|
258
274
|
|
|
259
|
-
|
|
275
|
+
MIT
|