From 2e07e3e00ff9fee28cb2703300e2f44751a99229 Mon Sep 17 00:00:00 2001 From: Koichi ITO Date: Sun, 27 Sep 2026 03:44:08 +0900 Subject: [PATCH] [Doc] Drop the trailing slash from directory paths in the documentation Directory paths in prose were written inconsistently: `examples/` next to `examples/rails` in the README and on the Examples page, `app/tools/` next to `config/routes.rb`, and `rails/` in an examples README heading. The trailing slash carries no information in prose, so every directory path in user-facing markdown now follows the no-trailing-slash form. --- README.md | 2 +- docs/examples.md | 4 ++-- examples/README.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7a71fb27..3d6996e4 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ see [Client Transports](https://ruby.sdk.modelcontextprotocol.io/client/transpor ## Examples -Runnable examples are available in [`examples/`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples), +Runnable examples are available in [`examples`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples), including a complete Rails application in [`examples/rails`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples/rails). ## Documentation diff --git a/docs/examples.md b/docs/examples.md index 819f4c11..3951255b 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -7,7 +7,7 @@ permalink: /examples/ # Examples -Runnable examples live in [`examples/`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples) in the repository. +Runnable examples live in [`examples`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples) in the repository. ## Standalone Scripts @@ -30,7 +30,7 @@ See [`examples/README.md`](https://github.com/modelcontextprotocol/ruby-sdk/blob [`examples/rails`](https://github.com/modelcontextprotocol/ruby-sdk/tree/main/examples/rails) is a complete, minimal Rails application serving an MCP server over the Streamable HTTP transport. The server and transport are built once -at boot and mounted at `/mcp` in `config/routes.rb`; tools live in `app/tools/`, and a text resource is served through +at boot and mounted at `/mcp` in `config/routes.rb`; tools live in `app/tools`, and a text resource is served through a `resources_read_handler`. ```console diff --git a/examples/README.md b/examples/README.md index af1828a7..8e889582 100644 --- a/examples/README.md +++ b/examples/README.md @@ -141,10 +141,10 @@ The client will: - Provide an interactive menu to trigger notifications - Display all received SSE events in real-time -### 7. Rails Server (`rails/`) +### 7. Rails Server (`rails`) A minimal Rails application that mounts `StreamableHTTPTransport` in its routes, following the "Rails (mount)" pattern from the top-level README. -It demonstrates class-based tools in `app/tools/` and a resource with a read handler. +It demonstrates class-based tools in `app/tools` and a resource with a read handler. **Usage:**