Skip to content

Commit d69035a

Browse files
authored
docs: updating README.md (#116)
1 parent e8d9c21 commit d69035a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ ollmcp
136136
#### MCP Server Configuration:
137137
138138
- `--mcp-server`, `-s`: Path to one or more MCP server scripts (.py or .js). Can be specified multiple times.
139-
- `--mcp-server-url`, `-u`: URL to one or more SSE or Streamable HTTP MCP servers. Can be specified multiple times.
140-
- `--servers-json`, `-j`: Path to a JSON file with server configurations.
139+
- `--mcp-server-url`, `-u`: URL to one or more SSE or Streamable HTTP MCP servers. Can be specified multiple times. See [Common MCP endpoint paths](#common-mcp-endpoint-paths) for typical endpoints.
140+
- `--servers-json`, `-j`: Path to a JSON file with server configurations. See [Server Configuration Format](#server-configuration-format) for details.
141141
- `--auto-discovery`, `-a`: Auto-discover servers from Claude's default config file (default behavior if no other options provided).
142142
143143
> [!TIP]
@@ -534,7 +534,7 @@ A common point of confusion is where to store MCP server configuration files and
534534
You can then point `ollmcp` at that file at startup with `-j` / `--servers-json`.
535535
536536
> [!IMPORTANT]
537-
> When using HTTP-based MCP servers, use the `streamable_http` type (not just `http`).
537+
> When using HTTP-based MCP servers, use the `streamable_http` type (not just `http`). Also check the [Common MCP endpoint paths](#common-mcp-endpoint-paths) section below for typical endpoints.
538538
539539
Here a minimal working example let's say this is your `~/.config/ollmcp/mcp-servers/config.json`:
540540
@@ -569,7 +569,12 @@ A short demo (asciicast) that should help anyone reproduce the working setup qui
569569
570570
[![asciicast](https://asciinema.org/a/751387.svg)](https://asciinema.org/a/751387)
571571
572+
#### Common MCP endpoint paths
572573
574+
Streamable HTTP MCP servers typically expose the MCP endpoint at `/mcp` (e.g., `https://host/mcp`), while SSE servers commonly use `/sse` (e.g., `https://host/sse`). Below is an excerpt from the MCP specification (2025-06-18):
575+
> The server MUST provide a single HTTP endpoint path (hereafter referred to as the MCP endpoint) that supports both POST and GET methods. For example, this could be a URL like https://example.com/mcp.
576+
577+
You can find more details in the [MCP specification version 2025-06-18 - Transports](https://modelcontextprotocol.io/specification/2025-06-18/basic/transports).
573578
574579
## Compatible Models
575580

0 commit comments

Comments
 (0)