Spaces:
Running
Running
| --- | |
| title: cursor | |
| sidebarTitle: cursor | |
| --- | |
| # `fastmcp.cli.install.cursor` | |
| Cursor integration for FastMCP install using Cyclopts. | |
| ## Functions | |
| ### `generate_cursor_deeplink` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/cursor.py#L20" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| generate_cursor_deeplink(server_name: str, server_config: StdioMCPServer) -> str | |
| ``` | |
| Generate a Cursor deeplink for installing the MCP server. | |
| **Args:** | |
| - `server_name`: Name of the server | |
| - `server_config`: Server configuration | |
| **Returns:** | |
| - Deeplink URL that can be clicked to install the server | |
| ### `open_deeplink` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/cursor.py#L44" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| open_deeplink(deeplink: str) -> bool | |
| ``` | |
| Attempt to open a deeplink URL using the system's default handler. | |
| **Args:** | |
| - `deeplink`: The deeplink URL to open | |
| **Returns:** | |
| - True if the command succeeded, False otherwise | |
| ### `install_cursor` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/cursor.py#L67" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| install_cursor(file: Path, server_object: str | None, name: str) -> bool | |
| ``` | |
| Install FastMCP server in Cursor. | |
| **Args:** | |
| - `file`: Path to the server file | |
| - `server_object`: Optional server object name (for \:object suffix) | |
| - `name`: Name for the server in Cursor | |
| - `with_editable`: Optional directory to install in editable mode | |
| - `with_packages`: Optional list of additional packages to install | |
| - `env_vars`: Optional dictionary of environment variables | |
| - `python_version`: Optional Python version to use | |
| - `with_requirements`: Optional requirements file to install from | |
| - `project`: Optional project directory to run within | |
| **Returns:** | |
| - True if installation was successful, False otherwise | |
| ### `cursor_command` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/cursor.py#L153" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| cursor_command(server_spec: str) -> None | |
| ``` | |
| Install an MCP server in Cursor. | |
| **Args:** | |
| - `server_spec`: Python file to install, optionally with \:object suffix | |