docs: improve documentation clarity and client integration steps (#567)

- Fix typo in "TroubleShooting" heading, changing it to
"Troubleshooting"
- Improve CLI usage instructions by formatting commands as code blocks
and marking them with "bash"
- Change "Start the Server" to a third-level heading for clarity
- Add additional code examples for real-world client testing and
interaction steps
- Clarify and condense instructions for adding the tool to a popular MCP
client

---------

Signed-off-by: appleboy <appleboy.tw@gmail.com>
Co-authored-by: Robert Findley <rfindley@google.com>
This commit is contained in:
Bo-Yi Wu 2025-10-13 23:47:58 +08:00 • committed by GitHub
commit 920e5a39ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 40 additions and 36 deletions

View file

@ -10,7 +10,7 @@ The example implements:
## Usage ## Usage
Start the Server ### Start the Server
```bash ```bash
go run . server go run . server
@ -31,21 +31,24 @@ The client will:
At any given time you can pass a custom URL to the program to run it on a custom host/port: At any given time you can pass a custom URL to the program to run it on a custom host/port:
```
```bash
go run . -host 0.0.0.0 -port 9000 server go run . -host 0.0.0.0 -port 9000 server
``` ```
## Testing with real-world MCP Clients ## Testing with real-world MCP Clients
Once the server is started, assuming it's the default Once the server is started, assuming it's the default localhost:8080, you can try to add it to a popular MCP client:
localhost:8080, you can try to add it to a popular MCP client:
```bash
claude mcp add -t http timezone http://localhost:8080 claude mcp add -t http timezone http://localhost:8080
```
Once added, Claude Code will be able to discover and use the `cityTime` tool provided by this server. Once added, Claude Code will be able to discover and use the `cityTime` tool provided by this server.
In Claude Code: In Claude Code:
```
> what's the timezone > what's the timezone
⏺ I'll get the current time in a major US city for you. ⏺ I'll get the current time in a major US city for you.
@ -64,3 +67,4 @@ In Claude Code:
- NYC (Eastern Time) - NYC (Eastern Time)
- SF (Pacific Time) - SF (Pacific Time)
- Boston (Eastern Time) - Boston (Eastern Time)
```