Update README (#2085)

Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
This commit is contained in:
Suchintan
2025-04-03 02:50:12 -04:00
committed by GitHub
parent 412073ca54
commit 8c664adbec
3 changed files with 117 additions and 20 deletions

View File

@@ -13,35 +13,46 @@
# Model Context Protocol (MCP)
Skyvern provides an MCP server implementation that seamlessly integrates with applications so your application gets access to the browser, fetching any live information from the browser and take actions through Skyvern's browser agent.
## Integration Options
Skyvern's MCP server implementation helps connect your AI Applications to the browser. This allows your AI applications to do things like: Fill out forms, download files, research information on the web, and more.
You can connect your MCP-enabled applications to Skyvern in two ways:
1. **Local Skyvern Server**
- Configure your applications to connect to skyvern server running on the localhost
- To run Skyvern server locally: `skyvern run server`
- Use your favourite LLM to power Skyvern
2. **Skyvern Cloud**
- Configure your applications to connect to Skyvern Cloud
- Create an account at [cloud.skyvern.com](https://cloud.skyvern.com)
- Create an account at [app.skyvern.com](https://app.skyvern.com)
- Get the API key from the settings page which will be used for setup
Follow the [installation instructions](#local) to set up.
## Quickstart
1. **Install Skyvern**
```bash
pip install skyvern
```
2. **Configure Skyvern** Run the setup wizard which will guide you through the configuration process. You can connect to either [Skyvern Cloud](https://app.skyvern.com) or a local version of Skyvern.
```bash
skyvern init
```
3. **(Optional) Launch the Skyvern Server. Only required in local mode**
```bash
skyvern run server
```
## Supported Applications
`skyvern init` helps configure the following applications for you:
- Cursor
- Windsurf
- Claude Desktop
- Your custom MCP App?
`skyvern init` helps you set up the MCP config files for these supported applications automatically - no need to copy-paste the config files. In case you want to set up Skyvern for any other MCP-enabled application, here's the config:
```
Use the following config if you want to set up Skyvern for any other MCP-enabled application
```json
{
"mcpServers": {
"Skyvern": {
"env": {
"SKYVERN_BASE_URL": "https://api.skyvern.com", # "http://localhost:8000" if running locally
"SKYVERN_API_KEY": "YOUR_SKYVERN_API_KEY" # find the local SKYVERN_API_KEY in the .env file after running `skyvern init`
"SKYVERN_API_KEY": "YOUR_SKYVERN_API_KEY" # find the local SKYVERN_API_KEY in the .env file after running `skyvern init` or in your Skyvern Cloud console
},
"command": "PATH_TO_PYTHON",
"args": [