You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-30Lines changed: 13 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,11 +24,14 @@ An MCP ([Model Context Protocol](https://modelcontextprotocol.io/introduction))
24
24
25
25
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).
26
26
27
-
### Remote Approach using SSE Server
27
+
For both approaches, you need to get your YepCode API credentials:
28
28
29
29
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:
32
35
33
36
```typescript
34
37
{
@@ -40,46 +43,26 @@ YepCode MCP server can be integrated with AI platforms like [Cursor](https://cur
40
43
}
41
44
```
42
45
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:
> - 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
-
72
61
### Local Approach
73
62
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
-
80
63
#### Using NPX
81
64
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:
83
66
84
67
```typescript
85
68
{
@@ -103,7 +86,7 @@ Add the following configuration to your AI platform settings:
103
86
docker build -t yepcode/mcp-server .
104
87
```
105
88
106
-
2.Add the following configuration to your AI platform settings:
0 commit comments