zuplo 6.70.57 → 6.70.60

package/docs/articles/limits.mdx

@@ -69,7 +69,7 @@ limits please contact sales to discuss pricing plans.
 
 Our general guidelines for what constitutes fair use are as follows:
 
-- Free Plan: 500 consumers or keys
+- Free Plan: 100 consumers or keys
 - Builder Plan: 1,000 consumers or keys
 - Enterprise Plan: Custom
 

package/docs/articles/mcp-quickstart-local.mdx

@@ -0,0 +1,99 @@
+---
+title: Dynamic MCP Server - Quickstart
+sidebar_label: "Dynamic MCP Server - Quickstart"
+---
+
+Zuplo allows you to instantly add a managed MCP Server to your existing API,
+powered by OpenAPI. In this guide we'll build one locally using the
+[Zuplo CLI](../cli/overview.mdx).
+
+If you're not familiar with Zuplo, it's recommended to go through
+[Step 1](./step-1-setup-basic-gateway-local.mdx) first.
+
+<Stepper>
+
+1. Create a **new project**
+
+   Create a new project and start the local development server:
+
+   ```bash
+   npx create-zuplo-api@latest
+   cd example-project
+   npm run dev
+   ```
+
+   See [Step 1](./step-1-setup-basic-gateway-local.mdx) for a walkthrough of the
+   `create-zuplo-api` prompts.
+
+1. Test the **Get all todos** route
+
+   The default template ships with a working todo API. Open the local **Route
+   Designer** at http://localhost:9100, select the **Get all todos** route, and
+   click the **Test** button next to the **Path** field.
+
+   A test dialog will open, click **Test** and you should see a `200 OK`
+   response with a few todos.
+
+   This is the basic API we're going to turn into a fully functioning MCP
+   Server.
+
+1. Create an **MCP Server**
+
+   On your `routes.oas.json` file, choose **Add** and then **MCP Server**.
+
+   ![Add Route](../../public/media/mcp-quickstart/add-mcp-route.png)
+
+   A new route will appear. Confirm the following values:
+   - **Summary**: enter `MCP Server`
+   - **Method**: choose `POST`
+   - **Path**: enter `/mcp` (the path can be anything, but /mcp is common)
+
+   Click the **Select Tools** option for your new MCP Server endpoint.
+
+   ![Select Tools](../../public/media/mcp-quickstart/select-mcp-tools.png)
+
+   You should see the MCP tools dialog. Check the tools from your `*.oas.json`
+   files that you want to surface in your MCP Server.
+
+   ![MCP Server](../../public/media/mcp-quickstart/mcp-tools-dialog.png)
+
+   Click **Update Tools**, then click **Save** at the bottom left.
+   Congratulations, you just published your first MCP Server! It's now available
+   locally at `http://localhost:9000/mcp`.
+
+1. Connect an **MCP Client**
+
+   You can connect any MCP client that can reach your local gateway. The AI
+   coding agent you configured in
+   [Step 1](./step-1-setup-basic-gateway-local.mdx) (such as Claude Code or
+   Cursor) is a great option — point it at your local MCP server URL:
+
+   ```
+   http://localhost:9000/mcp
+   ```
+
+   Since we didn't add authentication to our API, no credentials are required.
+
+   :::tip{title="Using a cloud MCP client"}
+
+   Cloud clients like the
+   [OpenAI playground](https://platform.openai.com/playground) can't reach
+   `localhost`. To use one, deploy your project first — see
+   [Step 4](./step-4-deploying-to-the-edge-local.mdx) — and use your deployed
+   MCP server URL instead.
+
+   :::
+
+1. Test your MCP Server
+
+   Prompt your MCP client to:
+
+   `list out all the todos`
+
+   The client should recognize that it needs to call the todos MCP Server.
+   Approve the tool call and you should see the todos listed 👏
+
+</Stepper>
+
+Congratulations! Now go read more about the
+[MCP Server handler](/docs/handlers/mcp-server).

package/docs/articles/mcp-quickstart.mdx

@@ -1,6 +1,6 @@
 ---
-title: MCP - Quick Start Guide
-sidebar_label: "MCP - Quick start"
+title: Dynamic MCP Server - Quickstart
+sidebar_label: "Dynamic MCP Server - Quickstart"
 ---
 
 Zuplo allows you to instantly add a managed MCP Server to your existing API,

package/docs/articles/step-1-setup-basic-gateway-local.mdx

@@ -8,127 +8,103 @@ sidebar_label: "1 - Setup Your Gateway"
   alternateLink="/articles/step-1-setup-basic-gateway"
 />
 
-In this tutorial we'll set up a simple gateway using Zuplo's local development.
-We'll use a simple origin API at [echo.zuplo.io](https://echo.zuplo.io). In
-later steps, we'll set up a Zuplo project and deploy it to the cloud.
+In this tutorial we'll set up a simple gateway using Zuplo's local development,
+powered by the [Zuplo CLI](../cli/overview.mdx). We'll use the default project
+template, which ships with a working todo API.
 
 ## Requirements
 
 - [Node.js](https://nodejs.org/en/download) 20.0.0 or higher
 
-## Getting Started
-
-### Create a new project from scratch
-
 <Stepper>
 
-1. Create a new project using
+1. **Create your project**
+
+   Create a new project with [create-zuplo-api](../cli/create-zuplo-api.mdx):
 
    ```bash
-   npx create-zuplo-api@latest --empty
+   npx create-zuplo-api@latest
    ```
 
-   The [create-zuplo-api](../cli/create-zuplo-api.mdx) tool supports creating
-   projects from templates. This tutorial creates an empty project, but you can
-   use other [templates](https://zuplo.com/examples) by specifying the
-   `--example` flag.
-
-1. Start your local gateway
+   The CLI walks you through a few prompts. First, name your project:
 
    ```bash
-   cd <your-new-project-directory>
-   npm run dev
+   ✔ What is your project named? … example-project
    ```
 
-1. Use the [local Route Designer](./local-development-routes-designer.mdx) to
-   create your first route. You can open the Route Designer by clicking the link
-   in the terminal after you run `npm run dev`.
+   Next, the CLI offers to create a matching project on the Zuplo Portal. Answer
+   **Yes** — this opens your browser to sign in (or create a free account) and
+   creates a Zuplo project to pair with your local one. If you already have an
+   account, you'll be asked which one to use.
 
    ```bash
-   Started local development setup
-   Ctrl+C to exit
-
-   🚀 Zuplo Gateway: http://localhost:9000
-   📘 Route Designer: http://localhost:9100 # <-- Your local route designer
+   ? Create a matching project on portal.zuplo.com? › No / Yes
    ```
 
-1. Add your first **Route**
+   Creating the matching project automatically **links** your local project to
+   Zuplo, so features like API keys work in later steps without any extra setup.
 
-   Inside of the Route Designer, click the **Add Route** button.
+   Finally, select any AI coding agents you'd like to configure, or choose
+   **None**:
 
-   ![Add Route](../../public/media/step-1-setup-basic-gateway-local/image.png)
-
-   Your API's first route will appear, with many options. First we'll configure
-   the route to match specific incoming requests to the gateway:
-   - **Summary**: Enter a summary, for example `Example Endpoint`.
-   - **Method**: Leave as `GET`.
-   - **Path**: The path will be pre-configured as `path-1`.
-   - **Operation ID**: Pre-configured based on the path summary.
+   ```bash
+   ? Which AI coding agents would you like to configure? › - Space to select. Return to submit
+   ◯   Claude Code - CLAUDE.md, .claude/, .mcp.json
+   ◯   GitHub Copilot
+   ◯   Cursor
+   ◯   Windsurf
+   ◯   OpenAI Codex
+   ◯   None
+   ```
 
-   Then we'll specify how the route will invoke the backend origin API, using a
-   forward handler:
-   - **Request Handler**: We'll use the
-     [URL Forward Handler](../handlers/url-forward.mdx) which proxies requests
-     by "Forwarding to" the same path on specified URL. In this case, enter
-     `https://echo.zuplo.io`
+1. **Start your local gateway**
 
-     ![Your First Route](../../public/media/step-1-setup-basic-gateway-local/image-1.png)
+   Change into your new project directory and start the development server:
 
-   **Save your changes** - click **Save** in the bottom left, or press **CMD+S**
+   ```bash
+   cd example-project
+   npm run dev
+   ```
 
-1. **Test** your route
+   The terminal prints links to your local gateway, Route Designer, and a local
+   Docs Server:
 
-   You can test this route by clicking the **Test Route** button in the route
-   designer.
+   ```bash
+   Started local development setup
+   Ctrl+C to exit
 
-   ![Testing in the Route Designer](../../public/media/step-1-setup-basic-gateway-local/test.png)
+   🚀 Zuplo Gateway: http://localhost:9000
+   📘 Route Designer: http://localhost:9100
+   📄 Docs Server: http://localhost:9200
+   ⚙️  Loaded env files:
+       - .env.zuplo
+   ```
 
-   Alternatively, you can test the route in your favorite HTTP Client (for
-   example Postman, HTTPie, curl, etc).
+1. **Explore your API**
 
-   ```bash
-   curl http://localhost:9000/0
-
-   {
-      "url": "https://echo.zuplo.io/path-1",
-      "method": "GET",
-      "query": {},
-      "headers": {
-         "accept-encoding": "gzip, br",
-         "connection": "Keep-Alive",
-         "host": "echo.zuplo.io",
-         "true-client-ip": "2a06:98c0:3600::103",
-         "x-forwarded-proto": "https",
-         "x-real-ip": "2a06:98c0:3600::103",
-         "zp-rid": "b9822e0f-af32-4002-a6ba-3a899c7f2669",
-         "zuplo-request-id": "b9822e0f-af32-4002-a6ba-3a899c7f2669"
-      }
-   }
-   ```
+   The default template ships with a working **todo API** — four routes
+   (`GET /todos`, `POST /todos`, `PUT /todos/{id}`, `DELETE /todos/{id}`)
+   defined in `config/routes.oas.json`.
 
-1. Now that you have a simple gateway running, we can deploy it to the cloud
-   using the [Zuplo CLI](../cli/overview.mdx). When you run this command, you
-   will be prompted to login if you haven't already.
+   Open the [local Route Designer](./local-development-routes-designer.mdx) at
+   http://localhost:9100 — you can also click the link printed in the terminal —
+   to see the routes. Select **Get all todos** to inspect how it's configured;
+   you can change the path, method, request handler, and add policies from here.
 
-   If you haven't already created a Zuplo project, you will be prompted to do
-   so. If you do have a project, you can choose to deploy to it or you can
-   specify the `--project` flag to specify the project you want to deploy to.
+1. **Test the API**
 
-   ```bash
-   npx zuplo deploy
-   ```
+   Test the **Get all todos** route by clicking the **Test** button next to the
+   **Path** field in the Route Designer.
 
-   You should see output similar to this:
+   You can also call it directly with your favorite HTTP client (for example
+   Postman, HTTPie, or curl):
 
    ```bash
-   ? You don't have any projects configured for this account.
-     Enter the name of the new project: my-tutorial
-   ✔ Project my-tutorial created successfully.
-   ✔ Deployed to https://my-tutorial-main-11686c3.zuplo.app (93/150)
+   curl http://localhost:9000/todos
    ```
 
-   Your project is now deployed to the cloud and you can access it at the URL
-   provided in the output.
+   You should receive a `200 OK` response with a JSON list of todos. Your
+   gateway is now serving traffic locally.
 
 </Stepper>
 

package/docs/articles/step-2-add-rate-limiting-local.mdx

@@ -3,11 +3,6 @@ title: Step 2 - Add Rate Limiting
 sidebar_label: "2 - Rate Limiting"
 ---
 
-<QuickstartPicker
-  mode="local"
-  alternateLink="/articles/step-2-add-rate-limiting"
-/>
-
 In this guide we'll add simple Rate Limiting to a route. If you don't have one
 ready, complete [Step 1](./step-1-setup-basic-gateway-local.mdx) first.
 
@@ -25,100 +20,74 @@ built-in (including rate limiting) to save you time. You can check out
 :::
 
 Zuplo offers a programmable approach to rate limiting that allows you to vary
-how rate limiting is applied for each customer, or request.s
+how rate limiting is applied for each customer or request.
 
-In this example, we'll add a simple IP based rate limiter, but you should look
-into dynamic rate limiting to see the full power of the world's best rate
-limiter.
+In this example, we'll add a simple IP-based rate limiter, but you should also
+explore [dynamic rate limiting](./step-5-dynamic-rate-limiting-local.mdx) to see
+the full power of the world's best rate limiter.
 
 <Stepper>
 
-1.  Link your Local Project
-
-    When developing locally with Zuplo, you can "link" your local project to
-    your Zuplo project using the `zuplo link` command. This allows you to test
-    your changes in a real environment.
-
-    When you run the command you will be prompted to select your Zuplo account,
-    project, and environment. You can pick any environment.
-
-    ```bash
-    npx zuplo link
-    ```
-
-    After your project is linked, environment variables and other configuration
-    from your Zuplo project will be available in your local development
-    environment.
-
-1.  Start your Project
-
-    You can start your project using the following command:
-
-    ```bash
-    npx zuplo dev
-    ```
-
-    After your project is started, you can open the local route designer at
-    http://localhost:9100.
+1. Add the rate-limiting Policy
 
-1.  Add the rate-limiting Policy
+   Open the local **Route Designer** at http://localhost:9100. If your gateway
+   isn't already running, start it from your project directory with
+   `npm run dev`.
 
-    Open the local **Route Designer** by navigating to http://localhost:9100/.
-    Select your route and click **Add Policy** on the incoming Request policies
-    section.
+   Select your route and click **Add Policy** on the incoming request policies
+   section.
 
-    <BrowserScreenshot url="http://localhost:9100/?path=routes.oas.json">
+   <BrowserScreenshot url="http://localhost:9100/?path=routes.oas.json">
 
-    ![Add Policy](../../public/media/step-2-add-rate-limiting-local/image.png)
+   ![Add Policy](../../public/media/step-2-add-rate-limiting-local/image.png)
 
-    </BrowserScreenshot>
+   </BrowserScreenshot>
 
-    Search for the Rate Limiting policy (not the "Complex" one) and click it.
+   Search for the Rate Limiting policy (not the "Complex" one) and click it.
 
-    <ModalScreenshot>
+   <ModalScreenshot>
 
-    ![Add rate-limiting policy](../../public/media/step-2-add-rate-limiting/choose-rate-limiter.png)
+   ![Add rate-limiting policy](../../public/media/step-2-add-rate-limiting/choose-rate-limiter.png)
 
-    </ModalScreenshot>
+   </ModalScreenshot>
 
-    By default, the policy will rate limit based on the caller's IP address (as
-    indicated by the `rateLimitBy` field). It will allow 2 requests
-    (`requestsAllowed`) every 1 minute (`timeWindowMinutes`). You can explore
-    the rest of the policy's documentation and configuration in the right panel.
+   By default, the policy will rate limit based on the caller's IP address (as
+   indicated by the `rateLimitBy` field). It will allow 2 requests
+   (`requestsAllowed`) every 1 minute (`timeWindowMinutes`). You can explore the
+   rest of the policy's documentation and configuration in the right panel.
 
-    ![Rate limiting policy](../../public/media/step-2-add-rate-limiting/create-policy.png)
+   ![Rate limiting policy](../../public/media/step-2-add-rate-limiting/create-policy.png)
 
-    To apply the policy, click **Create Policy**. Then, save your changes to
-    redeploy.
+   To apply the policy, click **Create Policy**, then save your changes.
 
-1.  Testing your Policy
+1. Testing your Policy
 
-    Now try firing some requests against your API. You should receive a **429
-    Too many requests** on your 3rd request. You can use any API test tool you
-    prefer, such as Postman, HTTPie, or curl.
+   Now try firing some requests against your API. You should receive a **429 Too
+   many requests** on your 3rd request. You can use any API test tool you
+   prefer, such as Postman, HTTPie, or curl.
 
-    ```bash
-    curl http://localhost:9000/path-1
-    ```
+   ```bash
+   curl http://localhost:9000/todos
+   ```
 
-    After you make the request 3 times you will see a response similar to:
+   After you make the request 3 times you will see a response similar to:
 
-    ```json
-    {
-      "type": "https://httpproblems.com/http-status/429",
-      "title": "Too Many Requests",
-      "status": 429,
-      "instance": "/path-1",
-      "trace": {
-        "timestamp": "2025-08-26T21:50:40.220Z",
-        "requestId": "4c62d425-2cb0-4a6c-9ac0-8d04a5f10c57",
-        "buildId": "f49c4070-7c0a-441b-a5fd-4e35b5fe41b7"
-      }
-    }
-    ```
+   ```json
+   {
+     "type": "https://httpproblems.com/http-status/429",
+     "title": "Too Many Requests",
+     "status": 429,
+     "instance": "/todos",
+     "trace": {
+       "timestamp": "2025-08-26T21:50:40.220Z",
+       "requestId": "4c62d425-2cb0-4a6c-9ac0-8d04a5f10c57",
+       "buildId": "f49c4070-7c0a-441b-a5fd-4e35b5fe41b7"
+     }
+   }
+   ```
 
-    Your rate limiting policy is now intercepting excess requests, protecting
-    your API.
+   Your rate limiting policy is now intercepting excess requests, protecting
+   your API.
 
 </Stepper>
 

package/docs/articles/step-2-add-rate-limiting.mdx

@@ -3,11 +3,6 @@ title: Step 2 - Add Rate Limiting
 sidebar_label: "2 - Rate Limiting"
 ---
 
-<QuickstartPicker
-  mode="portal"
-  alternateLink="/articles/step-2-add-rate-limiting-local"
-/>
-
 In this guide we'll add simple Rate Limiting to a route. If you don't have one
 ready, complete [Step 1](./step-1-setup-basic-gateway.mdx) first.