diff --git a/docs/assets/images/fastmcp_cloud/connect.png b/docs/assets/images/fastmcp_cloud/connect.png new file mode 100644 index 000000000..583202f34 Binary files /dev/null and b/docs/assets/images/fastmcp_cloud/connect.png differ diff --git a/docs/deployment/fastmcp-cloud.mdx b/docs/deployment/fastmcp-cloud.mdx index 1d735a490..02ad5bae8 100644 --- a/docs/deployment/fastmcp-cloud.mdx +++ b/docs/deployment/fastmcp-cloud.mdx @@ -23,12 +23,14 @@ Deploying to FastMCP Cloud takes just three simple steps. Visit [fastmcp.cloud](https://fastmcp.cloud) and sign in with your GitHub account. Create a project either by selecting an existing repository or using the FastMCP Cloud quickstart repo. FastMCP Cloud Quickstart Screen -### Step 2: Configure your Server +### Step 2: Configure Your Server The configuration screen lets you specify: - **Name**: The name of your project. This will be used to generate a unique URL for your server. - **Entrypoint**: The Python file containing your FastMCP server (e.g., `echo.py`). This field has the same syntax as the `fastmcp run` command, for example `echo.py:my_server` to specify a specific object in the file. -- **Authentication**: Whether to require OAuth for client connections. +- **Authentication**: If disabled, your server is open to the public. If enabled, only other members of your FastMCP Cloud organization will be able to connect. + +Note that FastMCP Cloud will automatically detect yours server's Python dependencies from either a `requirements.txt` or `pyproject.toml` file. FastMCP Cloud Configuration Screen @@ -43,12 +45,18 @@ Once you create your project, FastMCP Cloud will: FastMCP Cloud Deployment Screen -The deployed server is live and accessible at a URL like: +## Connect to Your Server + +Your deployed server will be accessible at a URL like: ``` https://your-project-name.fastmcp.app/mcp ``` -You should be able to connect to it as soon as you see the deployment succeed! +You should be able to connect to it as soon as you see the deployment succeed! In addition, you can instantly connect your server to a variety of popular LLM clients: -Any time you open a PR to your repo, FastMCP Cloud will create a new, unique URL for that branch. This allows you to test your changes before merging to production. Each merge to main will trigger a new deployment of the latest version of your server. \ No newline at end of file +FastMCP Cloud Connection Screen + +## Testing Changes + +Any time you open a PR to your connected repo, FastMCP Cloud will create a new server for that branch and deploy it on a unique URL. This allows you to test your changes before merging to production. Each merge to main will trigger a new deployment of the "production" version of your server. \ No newline at end of file