phoenix-oss/mcp-remote
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Refine README: Update terminology for clarity, specifying 'Local MCP Client' and 'Remote SSE MCP Server' to enhance understanding of communication channels.

Browse source
This commit is contained in:
Minoru Mizutani 2025-04-29 13:57:47 +09:00
parent 3dd92adc92
commit ce890c30a9
No known key found for this signature in database
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -110,27 +110,27 @@ This project uses Deno's NPM compatibility feature to directly import and use th
The core functionality relies on establishing two sets of communication channels based on the MCP HTTP+SSE transport specification: The core functionality relies on establishing two sets of communication channels based on the MCP HTTP+SSE transport specification:
1. **Client <-> Proxy:** 1. **Local MCP Client <-> Local STDIO MCP Proxy Server:**
- The proxy starts an HTTP server locally (defaulting to port 3334, configurable via the `[callback-port]` argument). - The STDIO MCP proxy starts an HTTP server locally (defaulting to port 3334, configurable via the `[callback-port]` argument).
- Your local MCP client connects to this server's SSE endpoint to receive messages *from* the proxy. - Your local MCP client connects to this server's SSE endpoint to receive messages *from* the proxy.
- The client sends messages *to* the proxy via HTTP POST requests to a specific endpoint provided by the proxy upon connection. - The client sends messages *to* the proxy via HTTP POST requests to a specific endpoint provided by the proxy upon connection.
2. **Proxy <-> Server:** 2. **Local STDIO MCP Proxy Server <-> Remote SSE MCP Server:**
- The proxy makes an initial HTTP connection to the remote MCP server specified by the `<server-url>` argument to establish an SSE connection. Any custom headers provided via the `--header` flag are sent during this setup. - The proxy makes an initial HTTP connection to the remote SSE MCP server specified by the `<server-url>` argument to establish an SSE connection. Any custom headers provided via the `--header` flag are sent during this setup.
- The proxy receives messages *from* the remote server via this SSE connection. - The proxy receives messages *from* the remote server via this SSE connection.
- The proxy sends messages *to* the remote server via HTTP POST requests to the endpoint provided by the server during the initial handshake. - The proxy sends messages *to* the remote server via HTTP POST requests to the endpoint provided by the server during the initial handshake.
Once both connections are established, the proxy relays messages between them: Once both connections are established, the proxy relays messages between them:
- HTTP POST messages received from the **Client** are forwarded as HTTP POST messages to the **Server**. - HTTP POST messages received from the **Local MCP Client** are forwarded as HTTP POST messages to the **Remote SSE MCP Server**.
- SSE messages received from the **Server** are forwarded as SSE messages to the **Client**. - SSE messages received from the **Remote SSE MCP Server** are forwarded as SSE messages to the **Local MCP Client**.
This creates a transparent bridge, allowing your local client to communicate with the remote server using the standard MCP HTTP+SSE transport. This creates a transparent bridge, allowing your local MCP client to communicate with the remote SSE MCP server using the standard MCP HTTP+SSE transport.
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
participant Client participant Client as Local MCP Client
participant Proxy as Proxy (mcp-remote-deno) participant Proxy as Local STDIO MCP Proxy Server (mcp-remote-deno)
participant Server participant Server as Remote SSE MCP Server
Client->>+Proxy: GET / (Establish SSE connection, http://localhost:3334) Client->>+Proxy: GET / (Establish SSE connection, http://localhost:3334)
Proxy-->>-Client: SSE stream opened, provides POST endpoint (/client-post) Proxy-->>-Client: SSE stream opened, provides POST endpoint (/client-post)