Skip to content

Commit da2d201

Browse files
authored
better docs (#15)
* better docs * added note about deploying/invoking apps on the quickstart via the mcp if desired * application purge v3, cleaned up headers, relocated mcp server note
1 parent 94d4549 commit da2d201

File tree

2 files changed

+99
-30
lines changed

2 files changed

+99
-30
lines changed

mcp.mdx

Lines changed: 93 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,79 @@ The **Kernel Model Context Protocol (MCP) server** gives any compatible AI model
77

88
**Open-source & fully-managed** — the source code is available [here](https://github.com/onkernel/kernel-mcp-server). It allows you to connect to Kernel's cloud-based browser infrastructure via MCP.
99

10-
## Endpoint
10+
🌐 **Use instantly** at `https://mcp.onkernel.com/mcp` — no installation required!
1111

12-
| Transport | Endpoint | Notes |
13-
| :-------------- | :----------------------------- | :------------------------------------------------ |
14-
| Streamable HTTP | `https://mcp.onkernel.com/mcp` | Primary (SSE is disabled due to Vercel timeouts) |
12+
## First Time? Start Here!
13+
14+
**Ready to try Kernel but don't see any apps yet?** Perfect! Here's how to get started:
15+
16+
### Step 1: Install Kernel MCP Server
17+
18+
Install the Kernel MCP server to your favorite MCP client using the [setup instructions](#setup-instructions) below.
19+
20+
### Step 2: Ask Your AI Assistant for Help
21+
22+
Once connected, simply ask in your MCP client chat:
23+
24+
```
25+
"How do I get a Kernel sample app set up locally?"
26+
```
27+
28+
Your AI assistant will use the `search_docs` tool to get you the latest quickstart instructions and guide you through setting up your first Kernel app!
29+
30+
### Step 3: Deploy & Test with MCP Tools
31+
32+
After you have a sample app locally, ask your assistant:
33+
34+
```
35+
"Deploy my sample app to Kernel"
36+
```
37+
38+
Then test it:
39+
40+
```
41+
"Run my app and get the title from onkernel.com"
42+
```
43+
44+
### Why This Approach?
45+
46+
-**Always up-to-date** - Your AI assistant fetches the latest docs
47+
-**Interactive guidance** - Get help customized to your setup
48+
-**Learn MCP tools** - Experience the power of `search_docs`, `deploy_app`, and `invoke_action`
49+
-**End-to-end workflow** - From local development to cloud deployment to execution
50+
51+
### What You'll Experience
52+
53+
Your AI assistant will help you:
54+
- Download and understand sample apps (`search_docs`)
55+
- Deploy your local code to the cloud (`deploy_app`)
56+
- Run actions and see results (`invoke_action`)
57+
- Create browser sessions in the cloud (`create_browser`)
58+
- Monitor deployments (`list_deployments`, `get_deployment`)
1559

1660
## Available Tools
1761
The server provides these tools for AI assistants:
1862

19-
### Kernel Apps
20-
- `deploy_app` - Deploy TypeScript or Python apps to Kernel
21-
- `list_apps` - List apps in your Kernel organization
22-
- `invoke_action` - Execute actions in Kernel apps
23-
- `get_deployment` - Get deployment status and logs
24-
- `list_deployments` - List all deployments
25-
- `get_invocation` - Get action invocation details
63+
### App Management
64+
- `deploy_app` - Deploy TypeScript or Python apps to Kernel
65+
- `list_apps` - List apps in your Kernel organization
66+
- `invoke_action` - Execute actions in Kernel apps
67+
- `get_deployment` - Get deployment status and logs
68+
- `list_deployments` - List all deployments
69+
- `get_invocation` - Get action invocation details
2670

2771
### Browser Automation
28-
- `create_browser` - Launch a new browser session
29-
- `get_browser` - Get browser session information
30-
- `delete_browser` - Terminate a browser session
31-
- `list_browsers` - List active browser sessions
72+
- `create_browser` - Launch a new browser session
73+
- `get_browser` - Get browser session information
74+
- `delete_browser` - Terminate a browser session
75+
- `list_browsers` - List active browser sessions
3276

3377
### Documentation & Search
34-
- `search_docs` - Search Kernel platform documentation and guides
35-
78+
- `search_docs` - Search Kernel platform documentation and guides
3679

3780
## Setup Instructions
3881

39-
Remote MCP connections are still early and we've found that the connection may fail or require multiple attempts. If you experience issues, try restarting your client or disabling and re-enabling the Kernel MCP server.
82+
Add the Kernel MCP server to your favorite MCP-compatible client using `https://mcp.onkernel.com/mcp`. Here are setup instructions for popular clients:
4083

4184
## Claude
4285

@@ -101,13 +144,7 @@ Click [here](cursor://anysphere.cursor-deeplink/mcp/install?name=kernel&config=e
101144

102145
Click [here](goose://extension?cmd=npx&arg=-y&arg=mcp-remote&arg=https%3A%2F%2Fmcp.onkernel.com%2Fmcp&timeout=300&id=kernel&name=Kernel&description=Access%20Kernel%27s%20cloud-based%20browsers%20via%20MCP) to install Kernel on Goose in one click.
103146

104-
<Info>
105-
Note: Goose needs to be told to use a specific MCP server when prompting. For example: "Use the Kernel MCP server to read the docs"
106-
</Info>
107-
108-
109-
110-
### Manual Set-Up: Goose Desktop
147+
### Goose Desktop
111148

112149
1. Click `...` in the top right corner of the Goose Desktop.
113150
2. Select `Advanced Settings` from the menu.
@@ -121,7 +158,7 @@ Click [here](goose://extension?cmd=npx&arg=-y&arg=mcp-remote&arg=https%3A%2F%2Fm
121158
- **Timeout**: `300`
122159
5. Click `Add` button.
123160

124-
### Manual Set-Up: Goose CLI
161+
### Goose CLI
125162

126163
1. Run the following command:
127164
```bash
@@ -202,19 +239,45 @@ Many other MCP-capable tools accept:
202239

203240
Configure these values wherever the tool expects MCP server settings.
204241

242+
## Usage Examples
243+
244+
### Deploy Local Apps to the Cloud
245+
246+
```
247+
Human: I have a Playwright automation script open in my editor. Can you deploy it to Kernel?
248+
Assistant: I'll read your local files and deploy them to Kernel for you.
249+
[Uses deploy_app tool to upload your code and create a cloud deployment]
250+
```
251+
252+
### Invoke Apps from Anywhere
253+
254+
```
255+
Human: Run my web-scraper app to get data from reddit.com
256+
Assistant: I'll execute your web-scraper action with reddit.com as the target.
257+
[Uses invoke_action tool to run your deployed app in the cloud]
258+
```
259+
260+
### Create Persistent Browser Sessions
261+
262+
```
263+
Human: Create a stealth browser session that I can reuse for testing login flows
264+
Assistant: I'll create a persistent, stealth-enabled browser that maintains state between uses.
265+
[Uses create_browser tool with persistence and stealth options]
266+
```
267+
205268
## FAQ
206269

207270
**Is the server open source?**
208271

209-
Yes — the source code is available [here](https://github.com/onkernel/kernel-mcp-server). You're welcome to self-host, contribute, or just browse.
272+
Yes — the source code is available [here](https://github.com/onkernel/kernel-mcp-server). You're welcome to self-host, contribute, or browse the code.
210273

211274
**Does Kernel store my data?**
212275

213-
For the MCP server, only encrypted refresh tokens and minimal metadata required for auth. For information about we handle data for our managed services, see our [Privacy Policy](/privacy).
276+
Only encrypted refresh tokens and minimal metadata required for auth; browser state lives in your Kernel organization and never leaves your tenancy.
214277

215-
**What scopes are required?**
278+
**What if the handshake fails?**
216279

217-
`browser.session`, `dom.read`, and `js.eval` by default. Narrow scopes in your client during OAuth.
280+
Restart your MCP client or disable/re-enable the Kernel server before opening a support ticket. Most connection issues resolve with a simple restart.
218281

219282
**Where do I file bugs or feature requests?**
220283

quickstart.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This quickstart guide will help you create, deploy, and run your first app on Ke
1010
- `npm` or `pnpm` to generate a sample Kernel app
1111
- A [Kernel account](/reference/api-keys) with an API key
1212

13+
> **Note:** You can also deploy and invoke apps using the [Kernel MCP server](/mcp) from AI assistants (Cursor, Goose, Claude, etc.).
14+
1315
## 1. Download the sample app
1416

1517
```bash
@@ -58,6 +60,8 @@ kernel deploy main.py # --env ANTHROPIC_API_KEY=XXX if Browser Use or Computer U
5860

5961
</CodeGroup>
6062

63+
> **Note:** Apps can also be deployed via the [Kernel MCP server](/mcp) from your AI assistant.
64+
6165
## 5. Invoke the app
6266

6367
<CodeGroup>
@@ -85,6 +89,8 @@ kernel invoke python-cu cu-task --payload '{"query": "Search for the top 3 resta
8589
8690
</CodeGroup>
8791
92+
> **Note:** Apps can also be invoked via the [Kernel MCP server](/mcp) from your AI assistant.
93+
8894
## Next steps
8995
9096
Nice work! With Kernel, you:

0 commit comments

Comments
 (0)