Use Mockflow with an AI agent

Create an Agent Access Key

Each key belongs to one workspace and one approved MCP client. Give every client its own key so you can see where it is used, rotate it, or revoke it without interrupting other clients.

1. 1Open your account menu, choose Settings, and select the workspace the client should access. You can also go directly to Agent Access Keys.
2. 2Choose Create Agent Access Key and enter a name that identifies the client and device, such as Codex on my laptop.
3. 3Choose View diagrams only for explanation and review, Full MCP access for a trusted client that should create, edit, and run work, or Custom access for a smaller grant.
4. 4Choose an expiry. Keys that can make changes must expire within 14 days; Full MCP access starts with a seven-day expiry.
5. 5Review the access summary, create the key, and copy it immediately. Mockflow shows the complete key only once.

Choose the smallest useful access

Connect your MCP client

Add the Mockflow Streamable HTTP server to your client. The server is the API address, not the website address, and the key must be sent as a Bearer Authorization header.

Choose your client below. Each example keeps the key in an environment variable or password prompt rather than a tracked project file.

# Load MOCKFLOW_AGENT_ACCESS_KEY from your approved secret store.
npx @modelcontextprotocol/inspector \
  --cli \
  --server-url "https://api.mockflow.app/mcp/v2" \
  --transport http \
  --header "Authorization: Bearer ${MOCKFLOW_AGENT_ACCESS_KEY}"

{
  "mcpServers": {
    "mockflow": {
      "type": "http",
      "url": "https://api.mockflow.app/mcp/v2",
      "headers": {
        "Authorization": "Bearer ${MOCKFLOW_AGENT_ACCESS_KEY}"
      }
    }
  }
}

{
  "servers": {
    "mockflow": {
      "type": "http",
      "url": "https://api.mockflow.app/mcp/v2",
      "headers": {
        "Authorization": "Bearer ${input:mockflow-agent-access-key}"
      }
    }
  },
  "inputs": [
    {
      "type": "promptString",
      "id": "mockflow-agent-access-key",
      "description": "Mockflow agent access key",
      "password": true
    }
  ]
}

# Load MOCKFLOW_AGENT_ACCESS_KEY from your approved secret store.
codex mcp add mockflow \
  --url "https://api.mockflow.app/mcp/v2" \
  --bearer-token-env-var "MOCKFLOW_AGENT_ACCESS_KEY"

Verify the connection

1. 1Close and restart the MCP client after adding the key.
2. 2Ask the client to connect to Mockflow and list the diagrams it can access.
3. 3Ask it to summarize its Mockflow capabilities and any missing permissions or workspace settings.
4. 4Start with a small read request, such as “Explain the checkout diagram without making changes,” before asking it to author or run a larger slice.

What you can do through MCP

Mockflow gives an MCP client a grant-scoped architecture workspace. The client can combine Mockflow with the files, tickets, or repositories it can already access, but it only receives the Mockflow capabilities allowed by the Agent Access Key.

Map an existing codebase without sending its source

Open a diagram's Implementation tab when the system already has a repository. Mockflow can give a connected coding agent stable architecture, contract, data-resource, and mapping targets without receiving repository files or credentials.

1. 1Choose Create mapper key. The preset is scoped to this diagram, follows its latest revision, exposes structure only, and expires after seven days.
2. 2Configure the key in the MCP client, then return to the Implementation tab and choose Copy MCP task.
3. 3Run the task from the local repository. The agent lists diagrams, reads the manifest's implementation-context link, and compares stable targets with local files, symbols, manifests, CODEOWNERS, and Git refs.
4. 4Keep evidence metadata-only. Repository paths, symbol names, manifest kinds, CODEOWNERS matches, and Git refs are supported; source snippets, file or manifest bodies, credentials, and arbitrary structured payloads are rejected.
5. 5If the proposal tool is available, let the agent submit one bounded proposal. Otherwise, review its candidate list and keep Mockflow unchanged. Human verification remains a later explicit action.

Give the agent a safe working loop

1. 1Discover: list available diagrams, select the target, and read the current model before planning changes.
2. 2Plan: ask for a bounded change slice that includes graph behavior, contracts or resources when needed, and at least one journey that can prove the route.
3. 3Author: let the agent use Mockflow's current component catalog and operation guidance instead of guessing component ports or write shapes.
4. 4Verify: validate the graph, check contract gaps, and run the saved critical journey. A connection alone is not executable behavior; handlers must own the response, failure, or message action.
5. 5Report: summarize evidence, assumptions, unresolved warnings, and exactly what changed. Create a checkpoint only when you need a stable review point.

What MCP deliberately cannot do

MCP can edit drafts, run transient journeys when enabled, validate work, and create checkpoints. It cannot approve contracts, publish work, create approved runs, create share links, or export artifacts. Those remain deliberate owner actions in Mockflow.

Troubleshooting

Continue learning

Read Journeys to learn how Mockflow explains successful and failed system paths, or Contracts and data to model APIs, messages, schemas, and logical resources.