Skip to content

Commit 6de5468

Browse files
committed
[Doc] Tweak stdio transport example code in the README
The example code is located at `./examples/stdio_server.rb`. Also, the content provided as input via stdio has been updated to avoid returning an error data. Using ping pong as an example, here's the difference: ## Before An error data is returned. ```console $ ./examples/stdio_server.rb {"jsonrpc":"2.0","id":"1","result":"pong"} {"jsonrpc":"2.0","id":null,"error":{"code":-32600,"message":"Invalid Request","data":"Method name must be a string and not start with \"rpc.\""}} ``` This error message is generated in the following location: https://github.com/Shopify/json-rpc-handler/blob/v0.1.1/lib/json_rpc_handler.rb#L70 ## After The expected result is returned without error data. ```console $ ./examples/stdio_server.rb {"jsonrpc":"2.0","id":"1","method":"ping"} {"jsonrpc":"2.0","id":"1","result":{}} ``` The other stdin example has been updated to use data that does not cause errors. With this document update, users can verify the behavior of the MCP server via stdin without using an MCP client.
1 parent 4db222f commit 6de5468

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,10 @@ transport.open
121121

122122
You can run this script and then type in requests to the server at the command line.
123123

124-
```
125-
$ ./stdio_server.rb
126-
{"jsonrpc":"2.0","id":"1","result":"pong"}
127-
{"jsonrpc":"2.0","id":"2","result":["ExampleTool"]}
128-
{"jsonrpc":"2.0","id":"3","result":["ExampleTool"]}
124+
```bash
125+
$ ./examples/stdio_server.rb
126+
{"jsonrpc":"2.0","id":"1","method":"ping"}
127+
{"jsonrpc":"2.0","id":"2","method":"tools/list"}
129128
```
130129

131130
## Configuration

0 commit comments

Comments
 (0)