Skip to content

Prepare Fix All

prepare-fix-all · Query · CodeAction · Code Actions

Revalidates a Code Fix and reports the bounded impact of one explicit Fix All scope without staging changes.

Availability: Built in and published in every operational mode.

Generated from Roslyn Workbench MCP 1.0.0-rc.1 (1.0.0-rc.1).

Behaviour annotations

Annotation Value
destructiveHint false
idempotentHint false
openWorldHint false
readOnlyHint true
title "Prepare Fix All"

Request

Property Type Required Description
actionId string Yes The opaque originating Code Fix reference.
scope string enum ("Document", "Project", "Solution") Yes The explicit Fix All scope.
maxChanges integer | null No The maximum number of changed source documents to allow.
affectedDocumentsLimit integer | null No The maximum number of affected document identities to return.
expectedSnapshot object Yes Echo the snapshot returned with the data or transaction state used to construct this request.
workspace object | null No Provide workspaceId, alias, path, or any combination.

Response

Success response

Property Type Required Description
ok boolean constant (true) Yes Whether the tool invocation succeeded.
data object | null Yes Tool-specific result payload.
snapshot object Yes Exact immutable workspace snapshot associated with the result, when available.
warnings array No Non-fatal warnings the agent should consider.

Error response

Property Type Required Description
ok boolean constant (false) Yes Whether the tool invocation succeeded.
error object Yes Structured error details when the invocation failed.
continuation oneOf No Action the agent should take before retrying or continuing.
diagnostics array No Diagnostics that explain the failed invocation.
warnings array No Non-fatal warnings the agent should consider.

Error response

Property Type Required Description
ok boolean constant (false) Yes Whether the tool invocation succeeded.
error object Yes Structured error details when the invocation failed.
diagnostics object Yes Diagnostics that explain the failed invocation.
reporting object No Error-reporting workflow available for an unhandled failure.

Bounded collections and continuation

These response locations publish returned items with explicit bounds and continuation state:

  • $/oneOf/0/properties/data/properties/affectedDocuments

Continuations and required actions

A response may include a structured continuation at the following schema location. Follow its tool call or user-action instruction instead of guessing how to continue:

  • $/oneOf/1/properties/continuation
Complete input schema
{
  "type": "object",
  "properties": {
    "actionId": {
      "description": "The opaque originating Code Fix reference.",
      "type": "string",
      "format": "uuid"
    },
    "scope": {
      "description": "The explicit Fix All scope.",
      "type": "string",
      "enum": [
        "Document",
        "Project",
        "Solution"
      ]
    },
    "maxChanges": {
      "description": "The maximum number of changed source documents to allow.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 50
    },
    "affectedDocumentsLimit": {
      "description": "The maximum number of affected document identities to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 20
    },
    "expectedSnapshot": {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "workspaceEpoch": {
          "type": "integer"
        },
        "snapshotId": {
          "type": "string",
          "format": "uuid"
        },
        "transactionRevision": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "workspaceId",
        "workspaceEpoch",
        "snapshotId",
        "transactionRevision"
      ],
      "description": "Echo the snapshot returned with the data or transaction state used to construct this request."
    },
    "workspace": {
      "description": "Provide workspaceId, alias, path, or any combination.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "alias": {
          "type": "string"
        },
        "path": {
          "description": "Absolute workspace path.",
          "type": "string"
        }
      }
    }
  },
  "required": [
    "actionId",
    "scope",
    "expectedSnapshot"
  ]
}
Complete output schema
{
  "type": "object",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "ok",
        "data",
        "snapshot"
      ],
      "properties": {
        "ok": {
          "const": true,
          "description": "Whether the tool invocation succeeded."
        },
        "data": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "actionId": {
              "description": "The opaque prepared action reference.",
              "type": "string",
              "format": "uuid"
            },
            "scope": {
              "description": "The accepted Fix All scope.",
              "type": "string",
              "enum": [