Skip to content

Commit a02d1c1

Browse files
authored
docs: document how to start a remote MCP Coder server (#19150)
Document how to start a remote MCP Coder server. Addresses coder/internal#823.
1 parent 75749ef commit a02d1c1

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/ai-coder/mcp-server.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCP Server
22

3-
Power users can configure Claude Desktop, Cursor, or other external agents to interact with Coder in order to:
3+
Power users can configure [claude.ai](https://claude.ai), Claude Desktop, Cursor, or other external agents to interact with Coder in order to:
44

55
- List workspaces
66
- Create/start/stop workspaces
@@ -12,6 +12,8 @@ Power users can configure Claude Desktop, Cursor, or other external agents to in
1212
1313
In this model, any custom agent could interact with a remote Coder workspace, or Coder can be used in a remote pipeline or a larger workflow.
1414

15+
## Local MCP server
16+
1517
The Coder CLI has options to automatically configure MCP servers for you. On your local machine, run the following command:
1618

1719
```sh
@@ -30,4 +32,27 @@ coder exp mcp server
3032
```
3133

3234
> [!NOTE]
33-
> The MCP server is authenticated with the same identity as your Coder CLI and can perform any action on the user's behalf. Fine-grained permissions and a remote MCP server are in development. [Contact us](https://coder.com/contact) if this use case is important to you.
35+
> The MCP server is authenticated with the same identity as your Coder CLI and can perform any action on the user's behalf. Fine-grained permissions are in development. [Contact us](https://coder.com/contact) if this use case is important to you.
36+
37+
## Remote MCP server
38+
39+
Coder can expose an MCP server via HTTP. This is useful for connecting web-based agents, like https://claude.ai/, to Coder. This is an experimental feature and is subject to change.
40+
41+
To enable this feature, activate the `oauth2` and `mcp-server-http` experiments using an environment variable or a CLI flag:
42+
43+
```sh
44+
CODER_EXPERIMENTS="oauth2,mcp-server-http" coder server
45+
# or
46+
coder server --experiments=oauth2,mcp-server-http
47+
```
48+
49+
The Coder server will expose the MCP server at:
50+
51+
```txt
52+
https://coder.example.com/api/experimental/mcp/http
53+
```
54+
55+
> [!NOTE]
56+
> At this time, the remote MCP server is not compatible with web-based ChatGPT.
57+
58+
Users can authenticate applications to use the remote MCP server with OAuth2. An authenticated application can perform any action on the user's behalf. Fine-grained permissions are in development.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy