Skip to content

Commit ba15eb1

Browse files
authored
Merge pull request #25 from yepcode/feat/update-readme
Focus README on local installation, trim remote approach details
2 parents 6e51b75 + d184220 commit ba15eb1

1 file changed

Lines changed: 10 additions & 44 deletions

File tree

README.md

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -32,47 +32,22 @@ YepCode is built to be the ideal platform for running a **dynamic MCP tools serv
3232

3333
- **Polyglot tool implementations**: Implement tools in **Python** or **Node.js** (or both). The same MCP server can expose tools backed by different runtimes—think of it as one MCP server that mixes implementations across several languages.
3434

35-
## Integration Guide
35+
For complete documentation, see the [YepCode MCP Server docs](https://yepcode.io/docs/mcp-server/).
3636

37-
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).
37+
## Installation
3838

39-
For both approaches, you need to get your YepCode API credentials:
39+
This package lets you run the YepCode MCP server **locally** or in your own infrastructure (NPX, Docker, or custom deployment). Integrate it with AI platforms like [Cursor](https://cursor.sh) or [Claude Desktop](https://www.anthropic.com/news/claude-desktop).
4040

41-
1. Sign up to [YepCode Cloud](https://yepcode.io/l/LQUKe)
42-
2. Visit `Settings` > `API credentials` to create a new API token.
43-
44-
### Remote Approach using SSE Server
45-
46-
- 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:
41+
> **Tip:** From your YepCode account you also have access to a hosted MCP server that doesn't require local installation. The connection URL is always: `https://cloud.yepcode.io/mcp`
4742
48-
```typescript
49-
{
50-
"mcpServers": {
51-
"yepcode-mcp-server": {
52-
"url": "https://cloud.yepcode.io/mcp/sk-c2E....RD/sse"
53-
}
54-
}
55-
}
56-
```
43+
### Prerequisites
5744

58-
- 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:
45+
Get your YepCode API credentials:
5946

60-
```typescript
61-
{
62-
"mcpServers": {
63-
"yepcode-mcp-server": {
64-
"url": "https://cloud.yepcode.io/mcp/sse",
65-
"headers": {
66-
"Authorization": "Bearer <sk-c2E....RD>"
67-
}
68-
}
69-
}
70-
}
71-
```
72-
73-
### Local Approach
47+
1. Sign up to [YepCode Cloud](https://yepcode.io/l/LQUKe)
48+
2. Visit `Settings` > `API credentials` to create a new API token.
7449

75-
#### Using NPX
50+
### Using NPX
7651

7752
Make sure you have Node.js installed (version 18 or higher), and use a configuration similar to the following:
7853

@@ -90,7 +65,7 @@ Make sure you have Node.js installed (version 18 or higher), and use a configura
9065
}
9166
```
9267

93-
#### Using Docker
68+
### Using Docker
9469

9570
1. Build the container image:
9671

@@ -183,15 +158,6 @@ You can control which tools are enabled by setting the `YEPCODE_MCP_TOOLS` envir
183158
If not specified, all built-in tools are enabled by default, but no process tools will be exposed.
184159

185160
```typescript
186-
// SSE server configuration with options
187-
{
188-
"mcpServers": {
189-
"yepcode-mcp-server": {
190-
"url": "https://cloud.yepcode.io/mcp/sk-c2E....RD/sse?mcpOptions=runCodeCleanup&tools=run_code,yc_api,mcp-tool,core"
191-
}
192-
}
193-
}
194-
195161
// NPX configuration with options
196162
{
197163
"mcpServers": {

0 commit comments

Comments
 (0)