Skip to content

Commit 0c973e2

Browse files
Minor changes in README to improve SSE server configuration
1 parent 655ca17 commit 0c973e2

1 file changed

Lines changed: 13 additions & 30 deletions

File tree

README.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@ An MCP ([Model Context Protocol](https://modelcontextprotocol.io/introduction))
2424

2525
YepCode MCP server can be integrated with AI platforms like [Cursor](https://cursor.sh) or [Claude Desktop](https://www.anthropic.com/news/claude-desktop) using either a remote approach (we offer a hosted version of the MCP server) or a local approach (NPX or Docker installation is required).
2626

27-
### Remote Approach using SSE Server
27+
For both approaches, you need to get your YepCode API credentials:
2828

2929
1. Sign up to [YepCode Cloud](https://cloud.yepcode.io)
30-
2. Get your MCP Server URL from your workspace under: `Settings` > `API credentials`.
31-
3. Add the following configuration to your AI platform settings:
30+
2. Visit `Settings` > `API credentials` to create a new API token.
31+
32+
### Remote Approach using SSE Server
33+
34+
- If your MCP Client doesn't support authentication headers, just use the SSE server URL that includes the API Token. Use a configuration similar to the following:
3235

3336
```typescript
3437
{
@@ -40,46 +43,26 @@ YepCode MCP server can be integrated with AI platforms like [Cursor](https://cur
4043
}
4144
```
4245

43-
We also support authentication using a Bearer token in the HTTP `Authorization` header. This is the recommended and most secure way to authenticate with the YepCode MCP server when your AI platform supports it.
44-
45-
- **Direct Bearer Authentication:**
46-
- If your AI platform or MCP client supports setting the `Authorization` header directly, simply provide your YepCode MCP Server URL with the required Bearer token. See your platform's documentation for details. For example, in Cursor, refer to their [MCP authentication docs](https://docs.cursor.com/context/model-context-protocol#authentication).
47-
48-
- **Using Remote-MCP as a Proxy:**
49-
- Some AI platforms or MCP clients do **not** natively support setting the `Authorization` header. In these cases, you can use [Remote-MCP](https://github.com/ssut/Remote-MCP) as a proxy. Remote-MCP injects the `Authorization` header for you, allowing you to connect securely to YepCode MCP Server.
50-
51-
**Example configuration using Remote-MCP:**
46+
- If your MCP Client supports authentication headers, you can use the HTTP server URL that includes the API Token. Use a configuration similar to the following:
5247

5348
```typescript
5449
{
5550
"mcpServers": {
56-
"remote-mcp": {
57-
"command": "npx",
58-
"args": ["-y", "@remote-mcp/client"],
59-
"env": {
60-
"REMOTE_MCP_URL": "https://cloud.yepcode.io/mcp/sse",
61-
"HTTP_HEADER_Authorization": "Bearer <sk-c2E....RD>"
51+
"yepcode-mcp-server": {
52+
"url": "https://cloud.yepcode.io/mcp/sse"
53+
"headers": {
54+
"Authorization": "Bearer <sk-c2E....RD>"
6255
}
6356
}
6457
}
6558
}
6659
```
6760

68-
> **Note:**
69-
> - Use Remote-MCP only if your platform does not support Bearer authentication natively.
70-
> - For the most up-to-date information on authentication support, check your platform's documentation or the [Model Context Protocol docs](https://modelcontextprotocol.io/introduction).
71-
7261
### Local Approach
7362

74-
#### Required Environment Variables
75-
76-
- `YEPCODE_API_TOKEN`: Your YepCode API token. How to obtain:
77-
1. Sign up to [YepCode Cloud](https://cloud.yepcode.io)
78-
2. Get your API token from your workspace under: `Settings` > `API credentials`
79-
8063
#### Using NPX
8164

82-
Add the following configuration to your AI platform settings:
65+
Make sure you have Node.js installed (version 18 or higher), and use a configuration similar to the following:
8366

8467
```typescript
8568
{
@@ -103,7 +86,7 @@ Add the following configuration to your AI platform settings:
10386
docker build -t yepcode/mcp-server .
10487
```
10588

106-
2. Add the following configuration to your AI platform settings:
89+
2. Use a configuration similar to the following:
10790

10891
```typescript
10992
{

0 commit comments

Comments
 (0)