MCP 2025-06-18

design.getBundle

Resolve the current immutable Design bundle for an authorized scope.

Scopes

The agent key needs these scopes. The server also checks access to each record before returning data or changing it.

read:design

Input schema

This schema is shared with tools/list, including the required fields and additionalProperties rules.

Synthetic example · JSON

{
  "type": "object",
  "properties": {
    "scope": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "enum": [
                "base",
                "organization"
              ]
            }
          },
          "required": [
            "kind"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "const": "component"
            },
            "componentId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "required": [
            "kind",
            "componentId"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "const": "project"
            },
            "projectId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "required": [
            "kind",
            "projectId"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "const": "family"
            },
            "projectId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "familyKey": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "required": [
            "kind",
            "projectId",
            "familyKey"
          ],
          "additionalProperties": false
        }
      ]
    },
    "ifContentHash": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "scope"
  ],
  "additionalProperties": false
}

Call this tool

Send it as POST https://www.specifywork.com/api/mcp. Authorization: Bearer <agent key>, a key that starts with sw_agent. Replace the example values with records your key can reach.

Synthetic example · JSON

{
  "jsonrpc": "2.0",
  "id": "example_design_getBundle",
  "method": "tools/call",
  "params": {
    "name": "design.getBundle",
    "arguments": {
      "scope": {
        "kind": "base"
      }
    }
  }
}

Read the result before continuing

The Design operation's result.

A call returns content[0].text with the JSON result and structuredContent.result with the same value. A refused call returns isError: true and the error code in content[0].text.

A request being accepted is not proof of an external action completing. Keep correlation IDs and mutation idempotency keys unchanged across safe retries.