Skip to content

Analyze Disposables

analyze-disposables · Query · CorePlugin · Code analysis

Returns advisory findings for undisposed local disposable values.

Availability: Built in and published by default.

Generated from Roslyn Workbench MCP 0.1.0-beta.304 (0.1.0-beta.304).

Behaviour annotations

Annotation Value
destructiveHint false
idempotentHint true
openWorldHint false
readOnlyHint true
title "Analyze Disposables"

Request

Property Type Required Description
scope object | null No The optional search scope.
findingsLimit integer | null No Maximum number of results to return.
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.

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.

Bounded collections and continuation

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

  • $/oneOf/0/properties/data/properties/findings

Continuations and required actions

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

  • $/oneOf/1/properties/continuation
Complete input schema
{
  "type": "object",
  "properties": {
    "scope": {
      "description": "The optional search scope.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "Solution",
            "Project",
            "Document",
            "Projects"
          ],
          "default": "Solution"
        },
        "project": {
          "description": "Used only when kind is Project.",
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "path": {
              "description": "Workspace-relative path.",
              "type": "string"
            },
            "targetFramework": {
              "type": "string"
            }
          }
        },
        "document": {
          "description": "Used only when kind is Document.",
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "project": {
              "description": "Disambiguates documents with matching paths or IDs.",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "projectId": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "path": {
                  "description": "Workspace-relative path.",
                  "type": "string"
                },
                "targetFramework": {
                  "type": "string"
                }
              }
            },
            "path": {
              "description": "Workspace-relative path.",
              "type": "string"
            },
            "documentId": {
              "description": "Workspace-local document ID.",
              "type": "string"
            }
          }
        },
        "projects": {
          "description": "Used only when kind is Projects.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "description": "Provide projectId, name, path, targetFramework, or any combination.",
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "projectId": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "path": {
                "description": "Workspace-relative path.",
                "type": "string"
              },
              "targetFramework": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "findingsLimit": {
      "description": "Maximum number of results to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 50
    },
    "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"
        }
      }
    }
  }
}
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": {
            "findings": {
              "description": "The returned findings.",
              "type": "object",
              "properties": {
                "items": {
                  "description": "Items returned in this page.",
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "description": "The finding kind.",
                        "type": "string"
                      },
                      "symbol": {
                        "description": "The associated local symbol.",
                        "type": [
                          "object",
                          "null"
                        ],
                        "properties": {
                          "displayName": {
                            "description": "The display name of the symbol.",
                            "type": "string"
                          },
                          "kind": {
                            "description": "The symbol kind.",
                            "type": "string"
                          },
                          "documentationCommentId": {
                            "description": "The documentation comment identifier, when available.",
                            "type": [
                              "string",