> ## Documentation Index > Fetch the complete documentation index at: https://gofastmcp.com/llms.txt > Use this file to discover all available pages before exploring further. # cursor # `fastmcp.cli.install.cursor` Cursor integration for FastMCP install using Cyclopts. ## Functions ### `generate_cursor_deeplink` ```python theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} 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` ```python theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} open_deeplink(deeplink: str) -> bool ``` Attempt to open a Cursor 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_workspace` ```python theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} install_cursor_workspace(file: Path, server_object: str | None, name: str, workspace_path: Path) -> bool ``` Install FastMCP server to workspace-specific Cursor configuration. **Args:** * `file`: Path to the server file * `server_object`: Optional server object name (for :object suffix) * `name`: Name for the server in Cursor * `workspace_path`: Path to the workspace directory * `with_editable`: Optional list of directories 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 ### `install_cursor` ```python theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} 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 list of directories 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 * `workspace`: Optional workspace directory for project-specific installation **Returns:** * True if installation was successful, False otherwise ### `cursor_command` ```python theme={"theme":{"light":"snazzy-light","dark":"dark-plus"}} cursor_command(server_spec: str) -> None ``` Install an MCP server in Cursor. **Args:** * `server_spec`: Python file to install, optionally with :object suffix Built with [Mintlify](https://mintlify.com).