synthtraffic Get started
Docs menu

Getting started

Synthtraffic MCP

Describe the traffic you need in plain language. Synthtraffic MCP helps your assistant find relevant examples, write a scenario, check it for errors, and review whether it covers your requirements.

The hosted service is available at:

https://mcp.synthtraffic.io/mcp

It does not require a Synthtraffic license, API key, login, local build, or subscription. Connect it once, then use it from ChatGPT, Codex, Cursor, or another client that supports remote MCP servers.

Connect to ChatGPT

Create a personal Synthtraffic plugin from the hosted MCP server:

  1. Open ChatGPT Settings → Security and login and turn on Developer mode. Availability can depend on your account or workspace policy.
  2. Open ChatGPT Plugins and select the plus button.
  3. Name the plugin Synthtraffic and describe it as “Create and check synthetic traffic scenarios.”
  4. Under Connection, enter https://mcp.synthtraffic.io/mcp as the MCP server URL. No authentication is required.
  5. Create the plugin and review the capabilities ChatGPT discovers.
  6. Open your personal Plugins directory, select Synthtraffic, and use the plus button to install it.

To use it, start a new Work chat, type @, select Synthtraffic, and describe the scenario you want. You can also ask naturally and let ChatGPT choose the installed plugin when it is relevant.

The current OpenAI flow is documented in the Plugins quickstart.

Connect to Codex

ChatGPT and Codex share the same Plugins directory. If you created and installed Synthtraffic with the steps above, you do not need to create it again.

  1. Open the ChatGPT desktop app and switch to Codex.
  2. Start a new task so the newly installed plugin is available.
  3. Type @Synthtraffic to select it explicitly, or ask Codex to use Synthtraffic while creating your scenario.

For example:

@Synthtraffic Create customer and order events with a valid relationship.
Return a complete YAML scenario I can run locally.

Plugins are available to Codex in the ChatGPT desktop app. The Codex IDE extension does not currently support plugins. See Use and install plugins for the supported surfaces.

Connect to Cursor

Use the one-click link:

Install Synthtraffic in Cursor

Cursor will show the server configuration and ask you to approve the installation. After it connects, start a new Agent chat and describe the scenario you want.

If the link does not open, add Synthtraffic manually. Open Cursor’s Customize page and add a remote MCP server, or create ~/.cursor/mcp.json for all projects:

{
  "mcpServers": {
    "synthtraffic": {
      "url": "https://mcp.synthtraffic.io/mcp"
    }
  }
}

For only one project, save the same configuration as .cursor/mcp.json inside that project. Cursor documents both options in its MCP guide.

Use Synthtraffic after connecting

Start with the outcome rather than DSL syntax. Include the event types, relationships, traffic pattern, destination, and unusual delivery behavior that matter to you.

Try prompts such as:

  • “Create customer and order events where every order points to an existing customer.”
  • “Model busy-hour traffic with duplicate and late deliveries.”
  • “Write rows to an existing PostgreSQL schema without changing the table.”
  • “Check whether this scenario covers cancellations and explain anything missing.”

Synthtraffic can find tested examples, answer DSL questions, and check a complete YAML or JSON scenario for source-aware errors. When it checks a scenario, it is doing the equivalent of a compiler check: the assistant should fix any reported errors before calling the scenario ready. For a checklist of business requirements, it can also report each item as covered, missing, or uncertain.

The result is scenario source that you save and run with the Synthtraffic CLI or Studio. MCP helps with authoring; it does not generate or deliver the events itself.

What leaves your client

  • Documentation searches, example retrieval, and scenario compilation run inside the hosted Synthtraffic service.
  • Example recommendations send your written request and public example descriptions to TypeSafe AI.
  • Requirement reviews send the scenario, your checklist, and relevant Synthtraffic documentation to TypeSafe AI.
  • The service does not execute scenarios, access your workspace, write files, open connections, or expand environment variables.

Do not include credentials, secrets, or private records in prompts or scenario text. Refer to credentials with env(...), just as you would in a scenario saved on your machine.

Local developer server

Source developers can run synthtraffic mcp as a local stdio server. That path requires the normal Synthtraffic license and uses TYPESAFE_API_KEY only for recommendation and requirement-review requests. Most users should connect to the hosted URL instead.

Next

  • Scenario file — understand the source your assistant returns
  • sample — preview generated events locally
  • Studio — edit and run the scenario in the local UI