mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-28 02:10:38 +02:00
Add Cursor support via CLI integration (#1052)
* Add Cursor support * Use url-safe encoding
This commit is contained in:
Jeremiah Lowin
GitHub
parent
ef742d9400
commit
e50f4ae965
20 changed files with 974 additions and 260 deletions
|
|
@ -139,6 +139,7 @@
|
|||
"integrations/chatgpt",
|
||||
"integrations/claude-code",
|
||||
"integrations/claude-desktop",
|
||||
"integrations/cursor",
|
||||
"integrations/gemini",
|
||||
"integrations/openai",
|
||||
"integrations/eunomia-authorization",
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@ title: Anthropic API + FastMCP
|
|||
sidebarTitle: Anthropic API
|
||||
description: Call FastMCP servers from the Anthropic API
|
||||
icon: message-smile
|
||||
tag: NEW
|
||||
---
|
||||
|
||||
import { VersionBadge } from "/snippets/version-badge.mdx"
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ description: Call FastMCP servers from Claude Desktop
|
|||
icon: message-smile
|
||||
---
|
||||
|
||||
import { VersionBadge } from "/snippets/version-badge.mdx"
|
||||
|
||||
|
||||
Claude Desktop supports MCP servers through local STDIO connections and remote servers (beta), allowing you to extend Claude's capabilities with custom tools, resources, and prompts from your FastMCP servers.
|
||||
|
||||
|
|
@ -47,22 +49,27 @@ if __name__ == "__main__":
|
|||
## Install the Server
|
||||
|
||||
### FastMCP CLI
|
||||
<VersionBadge version="2.10.3" />
|
||||
|
||||
The easiest way to install a FastMCP server in Claude Desktop is using the `fastmcp install` command. This automatically handles the configuration and dependency management.
|
||||
The easiest way to install a FastMCP server in Claude Desktop is using the `fastmcp install claude-desktop` command. This automatically handles the configuration and dependency management.
|
||||
|
||||
<Tip>
|
||||
Prior to version 2.10.3, Claude Desktop could be managed by running `fastmcp install <path>` without specifying the client.
|
||||
</Tip>
|
||||
|
||||
```bash
|
||||
fastmcp install server.py
|
||||
fastmcp install claude-desktop server.py
|
||||
```
|
||||
|
||||
The install command supports the same `file.py:object` notation as the `run` command. If no object is specified, it will automatically look for a FastMCP server object named `mcp`, `server`, or `app` in your file:
|
||||
|
||||
```bash
|
||||
# These are equivalent if your server object is named 'mcp'
|
||||
fastmcp install server.py
|
||||
fastmcp install server.py:mcp
|
||||
fastmcp install claude-desktop server.py
|
||||
fastmcp install claude-desktop server.py:mcp
|
||||
|
||||
# Use explicit object name if your server has a different name
|
||||
fastmcp install server.py:my_custom_server
|
||||
fastmcp install claude-desktop server.py:my_custom_server
|
||||
```
|
||||
|
||||
After installation, restart Claude Desktop completely. You should see a hammer icon (🔨) in the bottom left of the input box, indicating that MCP tools are available.
|
||||
|
|
@ -72,7 +79,7 @@ After installation, restart Claude Desktop completely. You should see a hammer i
|
|||
If your server has dependencies, include them with the `--with` flag:
|
||||
|
||||
```bash
|
||||
fastmcp install server.py --with pandas --with requests
|
||||
fastmcp install claude-desktop server.py --with pandas --with requests
|
||||
```
|
||||
|
||||
Alternatively, you can specify dependencies directly in your server code:
|
||||
|
|
@ -95,7 +102,7 @@ Claude Desktop runs servers in a completely isolated environment with no access
|
|||
If your server needs environment variables (like API keys), you must include them:
|
||||
|
||||
```bash
|
||||
fastmcp install server.py --name "Weather Server" \
|
||||
fastmcp install claude-desktop server.py --name "Weather Server" \
|
||||
--env-var API_KEY=your-api-key \
|
||||
--env-var DEBUG=true
|
||||
```
|
||||
|
|
@ -103,7 +110,7 @@ fastmcp install server.py --name "Weather Server" \
|
|||
Or load them from a `.env` file:
|
||||
|
||||
```bash
|
||||
fastmcp install server.py --name "Weather Server" --env-file .env
|
||||
fastmcp install claude-desktop server.py --name "Weather Server" --env-file .env
|
||||
```
|
||||
<Warning>
|
||||
- **`uv` must be installed and available in your system PATH**. Claude Desktop runs in its own isolated environment and needs `uv` to manage dependencies.
|
||||
|
|
|
|||
BIN
docs/integrations/cursor-install-mcp.png
Normal file
BIN
docs/integrations/cursor-install-mcp.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
191
docs/integrations/cursor.mdx
Normal file
191
docs/integrations/cursor.mdx
Normal file
|
|
@ -0,0 +1,191 @@
|
|||
---
|
||||
title: Cursor + FastMCP
|
||||
sidebarTitle: Cursor
|
||||
description: Install and use FastMCP servers in Cursor
|
||||
icon: message-smile
|
||||
tag: NEW
|
||||
---
|
||||
|
||||
import { VersionBadge } from "/snippets/version-badge.mdx"
|
||||
|
||||
Cursor supports MCP servers through multiple transport methods including STDIO, SSE, and Streamable HTTP, allowing you to extend Cursor's AI assistant with custom tools, resources, and prompts from your FastMCP servers.
|
||||
|
||||
<Note>
|
||||
This guide focuses specifically on installing local FastMCP server files directly into Cursor using STDIO transport. For deploying remote servers using SSE or HTTP transports, see the [Cursor MCP documentation](https://docs.cursor.com/context/mcp).
|
||||
</Note>
|
||||
|
||||
## Requirements
|
||||
|
||||
This integration uses STDIO transport to run your FastMCP server locally. For remote deployments, you can run your FastMCP server with HTTP or SSE transport and configure it directly in Cursor's settings.
|
||||
|
||||
## Create a Server
|
||||
|
||||
The examples in this guide will use the following simple dice-rolling server, saved as `server.py`.
|
||||
|
||||
```python server.py
|
||||
import random
|
||||
from fastmcp import FastMCP
|
||||
|
||||
mcp = FastMCP(name="Dice Roller")
|
||||
|
||||
@mcp.tool
|
||||
def roll_dice(n_dice: int) -> list[int]:
|
||||
"""Roll `n_dice` 6-sided dice and return the results."""
|
||||
return [random.randint(1, 6) for _ in range(n_dice)]
|
||||
|
||||
if __name__ == "__main__":
|
||||
mcp.run()
|
||||
```
|
||||
|
||||
## Install the Server
|
||||
|
||||
### FastMCP CLI
|
||||
<VersionBadge version="2.10.3" />
|
||||
|
||||
The easiest way to install a FastMCP server in Cursor is using the `fastmcp install cursor` command. This automatically handles the configuration, dependency management, and opens Cursor with a deeplink to install the server.
|
||||
|
||||
```bash
|
||||
fastmcp install cursor server.py
|
||||
```
|
||||
|
||||
The install command supports the same `file.py:object` notation as the `run` command. If no object is specified, it will automatically look for a FastMCP server object named `mcp`, `server`, or `app` in your file:
|
||||
|
||||
```bash
|
||||
# These are equivalent if your server object is named 'mcp'
|
||||
fastmcp install cursor server.py
|
||||
fastmcp install cursor server.py:mcp
|
||||
|
||||
# Use explicit object name if your server has a different name
|
||||
fastmcp install cursor server.py:my_custom_server
|
||||
```
|
||||
|
||||
After running the command, Cursor will open automatically and prompt you to install the server. The command will be `uv`, which is expected as this is a Python STDIO server. Click "Install" to confirm:
|
||||
|
||||
|
||||
|
||||
#### Dependencies
|
||||
|
||||
If your server has dependencies, include them with the `--with` flag:
|
||||
|
||||
```bash
|
||||
fastmcp install cursor server.py --with pandas --with requests
|
||||
```
|
||||
|
||||
Alternatively, you can specify dependencies directly in your server code:
|
||||
|
||||
```python server.py
|
||||
from fastmcp import FastMCP
|
||||
|
||||
mcp = FastMCP(
|
||||
name="Dice Roller",
|
||||
dependencies=["pandas", "requests"]
|
||||
)
|
||||
```
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
<Warning>
|
||||
Cursor runs servers in a completely isolated environment with no access to your shell environment or locally installed applications. You must explicitly pass any environment variables your server needs.
|
||||
</Warning>
|
||||
|
||||
If your server needs environment variables (like API keys), you must include them:
|
||||
|
||||
```bash
|
||||
fastmcp install cursor server.py --name "Weather Server" \
|
||||
--env-var API_KEY=your-api-key \
|
||||
--env-var DEBUG=true
|
||||
```
|
||||
|
||||
Or load them from a `.env` file:
|
||||
|
||||
```bash
|
||||
fastmcp install cursor server.py --name "Weather Server" --env-file .env
|
||||
```
|
||||
|
||||
<Warning>
|
||||
**`uv` must be installed and available in your system PATH**. Cursor runs in its own isolated environment and needs `uv` to manage dependencies.
|
||||
</Warning>
|
||||
|
||||
### Manual Configuration
|
||||
|
||||
For more control over the configuration, you can manually edit Cursor's configuration file. The configuration file is located at:
|
||||
- **All platforms**: `~/.cursor/mcp.json`
|
||||
|
||||
The configuration file is a JSON object with a `mcpServers` key, which contains the configuration for each MCP server.
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"dice-roller": {
|
||||
"command": "python",
|
||||
"args": ["path/to/your/server.py"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
After updating the configuration file, your server should be available in Cursor.
|
||||
|
||||
#### Dependencies
|
||||
|
||||
If your server has dependencies, you can use `uv` or another package manager to set up the environment.
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"dice-roller": {
|
||||
"command": "uv",
|
||||
"args": [
|
||||
"run",
|
||||
"--with", "pandas",
|
||||
"--with", "requests",
|
||||
"python",
|
||||
"path/to/your/server.py"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Warning>
|
||||
**`uv` must be installed and available in your system PATH**. Cursor runs in its own isolated environment and needs `uv` to manage dependencies.
|
||||
</Warning>
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
You can also specify environment variables in the configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"weather-server": {
|
||||
"command": "python",
|
||||
"args": ["path/to/weather_server.py"],
|
||||
"env": {
|
||||
"API_KEY": "your-api-key",
|
||||
"DEBUG": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Cursor runs servers in a completely isolated environment with no access to your shell environment or locally installed applications. You must explicitly pass any environment variables your server needs.
|
||||
</Warning>
|
||||
|
||||
## Using the Server
|
||||
|
||||
Once your server is installed, you can start using your FastMCP server with Cursor's AI assistant.
|
||||
|
||||
Try asking Cursor something like:
|
||||
|
||||
> "Roll some dice for me"
|
||||
|
||||
Cursor will automatically detect your `roll_dice` tool and use it to fulfill your request, returning something like:
|
||||
|
||||
> 🎲 Here are your dice rolls: 4, 6, 4
|
||||
>
|
||||
> You rolled 3 dice with a total of 14! The 6 was a nice high roll there!
|
||||
|
||||
The AI assistant can now access all the tools, resources, and prompts you've defined in your FastMCP server.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Eunomia Authorization + FastMCP
|
||||
sidebarTitle: Eunomia Authorization
|
||||
sidebarTitle: Eunomia Auth
|
||||
description: Add policy-based authorization to your FastMCP servers
|
||||
icon: layer-group
|
||||
tag: NEW
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@ title: Gemini SDK + FastMCP
|
|||
sidebarTitle: Gemini SDK
|
||||
description: Call FastMCP servers from the Google Gemini SDK
|
||||
icon: message-smile
|
||||
tag: NEW
|
||||
---
|
||||
|
||||
import { VersionBadge } from "/snippets/version-badge.mdx"
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ fastmcp --help
|
|||
| ------- | ------- | --------------------- |
|
||||
| `run` | Run a FastMCP server directly | Uses your current environment; you are responsible for ensuring all dependencies are available |
|
||||
| `dev` | Run a server with the MCP Inspector for testing | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
||||
| `install` | Install a server in the Claude desktop app | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
||||
| `install` | Install a server in MCP client applications | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
||||
| `inspect` | Generate a JSON report about a FastMCP server | Uses your current environment; you are responsible for ensuring all dependencies are available |
|
||||
| `version` | Display version information | N/A |
|
||||
|
||||
|
|
@ -144,22 +144,26 @@ fastmcp dev server.py -e . --with pandas --with matplotlib
|
|||
```
|
||||
|
||||
### `install`
|
||||
<VersionBadge version="2.10.3" />
|
||||
|
||||
Install a MCP server in the Claude desktop app.
|
||||
Install a MCP server in MCP client applications. FastMCP currently supports the following clients:
|
||||
|
||||
- **Claude Desktop** - Installs via direct configuration file modification
|
||||
- **Cursor** - Installs via deeplink that opens Cursor for user confirmation
|
||||
|
||||
```bash
|
||||
fastmcp install server.py
|
||||
fastmcp install claude-desktop server.py
|
||||
fastmcp install cursor server.py
|
||||
```
|
||||
|
||||
Note that for security reasons, Claude runs every MCP server in a completely isolated environment. Therefore, all dependencies must be explicitly specified using the `--with` and/or `--with-editable` options (following `uv` conventions) or by attaching them to your server in code via the `dependencies` parameter.
|
||||
Note that for security reasons, MCP clients run every server in a completely isolated environment. Therefore, all dependencies must be explicitly specified using the `--with` and/or `--with-editable` options (following `uv` conventions) or by attaching them to your server in code via the `dependencies` parameter.
|
||||
|
||||
<Warning>
|
||||
- **`uv` must be installed and available in your system PATH**. Claude Desktop runs in its own isolated environment and needs `uv` to manage dependencies.
|
||||
- **On macOS, it is recommended to install `uv` globally with Homebrew** so that Claude Desktop will detect it: `brew install uv`. Installing `uv` with other methods may not make it accessible to Claude Desktop.
|
||||
**`uv` must be installed and available in your system PATH**. Both Claude Desktop and Cursor run in isolated environments and need `uv` to manage dependencies. On macOS, install `uv` globally with Homebrew for Claude Desktop compatibility: `brew install uv`.
|
||||
</Warning>
|
||||
|
||||
<Warning>
|
||||
The `install` command currently only sets up servers for STDIO transport. When installed in the Claude desktop app, your server will be run using STDIO regardless of any transport configuration in your code.
|
||||
The `install` command currently only sets up servers for STDIO transport. When installed in MCP client applications, your server will be run using STDIO regardless of any transport configuration in your code.
|
||||
</Warning>
|
||||
|
||||
#### Server Specification
|
||||
|
|
@ -169,17 +173,33 @@ The `install` command supports the same `file.py:object` notation as the `run` c
|
|||
1. `server.py` - imports the module and looks for a FastMCP object named `mcp`, `server`, or `app`. Errors if no such object is found.
|
||||
2. `server.py:custom_name` - imports and uses the specified server object
|
||||
|
||||
#### Options
|
||||
|
||||
| Option | Flag | Description |
|
||||
| ------ | ---- | ----------- |
|
||||
| Server Name | `--name`, `-n` | Custom name for the server (defaults to server's name attribute or file name) |
|
||||
| Editable Package | `--with-editable`, `-e` | Directory containing pyproject.toml to install in editable mode |
|
||||
| Additional Packages | `--with` | Additional packages to install (can be used multiple times) |
|
||||
| Environment Variables | `--env-var`, `-v` | Environment variables in KEY=VALUE format (can be used multiple times) |
|
||||
| Environment File | `--env-file`, `-f` | Load environment variables from a .env file |
|
||||
|
||||
**Examples**
|
||||
|
||||
```bash
|
||||
# Auto-detects server object (looks for 'mcp', 'server', or 'app')
|
||||
fastmcp install server.py
|
||||
fastmcp install claude-desktop server.py
|
||||
|
||||
# Uses specific server object
|
||||
fastmcp install server.py:my_server
|
||||
fastmcp install claude-desktop server.py:my_server
|
||||
|
||||
# With custom name and dependencies
|
||||
fastmcp install server.py:my_server -n "My Analysis Server" --with pandas
|
||||
fastmcp install claude-desktop server.py:my_server -n "My Analysis Server" --with pandas
|
||||
|
||||
# Install in Cursor with environment variables
|
||||
fastmcp install cursor server.py --env-var API_KEY=secret --env-var DEBUG=true
|
||||
|
||||
# Install with environment file
|
||||
fastmcp install cursor server.py --env-file .env
|
||||
```
|
||||
|
||||
### `inspect`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue