Skip to content

Find Overrides

find-overrides · Query · CorePlugin · Code discovery and navigation

Finds distinct overriding methods, properties or events for a resolved member. Use this to follow virtual or abstract member overrides; use find-implementations for interface implementations or find-derived-types for type inheritance. Searches the selected projects, or the loaded solution when scope is omitted; a document scope searches its containing project. Returns the selected symbol and a bounded overrides collection of symbol references. overridesLimit defaults to 100; check overrides.hasMore before treating the list as complete. This is a read-only symbol search and does not execute the member.

Availability: Built in and published in every operational mode.

Generated from Roslyn Workbench MCP 0.0.0-dev (0.0.0-dev).

Behaviour annotations

Annotation Value
destructiveHint false
idempotentHint true
openWorldHint false
readOnlyHint true
title "Find Overrides"

Request

Property Type Required Description
symbol object Yes Provide exactly one of location or documentationCommentId.
scope object | null No Selects projects to search; a document scope searches its containing project. Omitted searches the loaded solution.
overridesLimit integer | null No Caps returned distinct overriding members. Omitted or null uses 100; zero returns no overrides.
expectedSnapshot object | null No 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/overrides

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": {
    "symbol": {
      "description": "Provide exactly one of location or documentationCommentId.",
      "type": "object",
      "properties": {
        "project": {
          "$ref": "#/$defs/project",
          "description": "Disambiguates symbols with matching identities."
        },
        "location": {
          "description": "Provide exactly one of span or selection.",
          "type": "object",
          "properties": {
            "span": {
              "type": "object",
              "properties": {
                "document": {
                  "$ref": "#/$defs/document",
                  "description": "Provide exactly one of path or documentId."
                },
                "range": {
                  "description": "Zero-based UTF-16 range.",
                  "type": "object",
                  "properties": {
                    "start": {
                      "description": "Zero-based UTF-16 offset.",
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "length": {
                      "description": "UTF-16 code-unit length.",
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    }
                  }
                }
              },
              "required": [
                "document",
                "range"
              ]
            },
            "selection": {
              "type": "object",
              "properties": {
                "document": {
                  "$ref": "#/$defs/document",
                  "description": "Provide exactly one of path or documentId."
                },
                "selectedText": {
                  "type": "string",
                  "minLength": 1
                },
                "contextBefore": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "contextAfter": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "document",
                "selectedText"
              ]
            }
          }
        },
        "documentationCommentId": {
          "type": "string"
        }
      }
    },
    "scope": {
      "description": "Selects projects to search; a document scope searches its containing project. Omitted searches the loaded solution.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "Solution",
            "Project",
            "Document",
            "Projects"
          ],
          "default": "Solution"
        },
        "project": {
          "$ref": "#/$defs/project",
          "description": "Used only when kind is Project."
        },
        "document": {
          "description": "Used only when kind is Document.",
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "project": {
              "$ref": "#/$defs/project",
              "description": "Disambiguates documents with matching paths or IDs."
            },
            "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": {
            "$ref": "#/$defs/project",
            "description": "Provide projectId, name, path, targetFramework, or any combination."
          }
        }
      }
    },
    "overridesLimit": {
      "description": "Caps returned distinct overriding members. Omitted or null uses 100; zero returns no overrides.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 100
    },
    "expectedSnapshot": {
      "type": [
        "object",
        "null"
      ],
      "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": [
    "symbol"
  ],
  "$defs": {
    "project": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "projectId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "path": {
          "description": "Workspace-relative path.",
          "type": "string"
        },
        "targetFramework": {
          "type": "string"
        }
      }
    },
    "document": {
      "type": "object",
      "properties": {
        "project": {
          "$ref": "#/$defs/project",
          "description": "Disambiguates documents with matching paths or IDs."
        },
        "path": {
          "description": "Workspace-relative path.",
          "type": "string"
        },
        "documentId": {
          "description": "Workspace-local document ID.",
          "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": {
            "symbol": {
              "description": "The queried base member.",
              "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",
                    "null"
                  ]
                },
                "location": {
                  "description": "The optional source location of the symbol.",
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "document": {
                      "description": "The resolved document.",
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "documentId": {
                          "description": "The document identifier.",
                          "type": "string"
                        },
                        "path": {
                          "description": "The normalized document path.",
                          "type": "string"
                        },
                        "projectId": {
                          "description": "The owning project identifier.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "documentId",
                        "path",
                        "projectId"
                      ]
                    },
                    "span": {
                      "description": "The resolved text span.",
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "start": {
                          "description": "Zero-based UTF-16 offset.",
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 2147483647
                        },
                        "length": {
                          "description": "UTF-16 code-unit length.",
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 2147483647
                        }
                      }
                    },
                    "line": {
                      "description": "The one-based line number.",
                      "type": "integer"
                    },
                    "column": {
                      "description": "The one-based column number.",
                      "type": "integer"
                    },
                    "snapshot": {
                      "description": "The exact immutable workspace snapshot associated with this location.",
                      "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"
                      ]
                    },
                    "selector": {
                      "description": "The canonical selector that can resolve this source location again.",
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "span": {
                          "type": "object",
                          "properties": {
                            "document": {
                              "description": "Provide exactly one of path or documentId.",
                              "type": "object",
                              "properties": {
                                "project": {
                                  "description": "Disambiguates documents with matching paths or IDs.",
                                  "type": [
                                    "object",
                                    "null"
                                  ],
                                  "properties": {
                                    "projectId": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "name": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "path": {
                                      "description": "Workspace-relative path.",
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    },
                                    "targetFramework": {
                                      "type": [
                                        "string",
                                        "null"
                                      ]
                                    }
                                  }
                                },
                                "path": {
                                  "description": "Workspace-relative path.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                },
                                "documentId": {
                                  "description": "Workspace-local document ID.",
                                  "type": [
                                    "string",
                                    "null"
                                  ]
                                }
                              }
                            },
                            "range": {
                              "description": "Zero-based UTF-16 range.",
                              "type": "object",
                              "properties": {
                                "start": {
                                  "description": "Zero-based UTF-16 offset.",
                                  "type": "integer",
                                  "minimum": 0,
                                  "maximum": 2147483647
                                },
                                "length": {
                                  "description": "UTF-16 code-unit length.",
                                  "type": "integer",
                                  "minimum": 0,
                                  "maximum": 2147483647
                                }
                              }
                            }
                          },
                          "required": [
                            "document",
                            "range"
                          ]
                        }
                      },
                      "required": [
                        "span"
                      ]
                    }
                  },
                  "required": [
                    "snapshot"
                  ]
                }
              },
              "required": [
                "displayName",
                "kind"
              ]
            },
            "overrides": {
              "description": "The returned overrides.",
              "type": "object",
              "properties": {
                "items": {
                  "description": "Items returned in this page.",
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "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",
                          "null"
                        ]
                      },
                      "location": {
                        "description": "The optional source location of the symbol.",
                        "$ref": "#/properties/request/properties/value/properties/symbol/properties/location"
                      }
                    },
                    "required": [
                      "displayName",
                      "kind"
                    ]
                  }
                },
                "hasMore": {
                  "description": "Whether additional items were available beyond this page.",
                  "type": "boolean"
                },
                "totalCount": {
                  "description": "Complete result count, when available without additional expensive work.",
                  "type": [
                    "integer",
                    "null"
                  ]
                }
              }
            }
          },
          "description": "Tool-specific result payload."
        },
        "snapshot": {
          "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": "Exact immutable workspace snapshot associated with the result, when available."
        },
        "warnings": {
          "type": "array",
          "description": "Non-fatal warnings the agent should consider.",
          "items": {
            "$ref": "#/$defs/warningInfo"
          }
        }
      }
    },
    {
      "type": "object",
      "required": [
        "ok",
        "error"
      ],
      "properties": {
        "ok": {
          "const": false,
          "description": "Whether the tool invocation succeeded."
        },
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "description": "Stable machine-readable error code.",
              "type": "string"
            },
            "message": {
              "description": "Human-readable explanation of the failure.",
              "type": "string"
            },
            "correlationId": {
              "description": "Correlation identifier for matching the failure to server-side diagnostics, when available.",
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "code",
            "message"
          ],
          "description": "Structured error details when the invocation failed."
        },
        "continuation": {
          "oneOf": [
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "tool",
                "instruction"
              ],
              "properties": {
                "kind": {
                  "const": "CallTool",
                  "description": "Action required before the original request can continue."
                },
                "instruction": {
                  "type": "string",
                  "description": "Agent-facing instruction explaining how to continue.",
                  "minLength": 1
                },
                "tool": {
                  "type": "string",
                  "description": "Tool to call before continuing the original request.",
                  "minLength": 1
                }
              }
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "tools",
                "instruction"
              ],
              "properties": {
                "kind": {
                  "const": "ChooseTool",
                  "description": "Action required before the original request can continue."
                },
                "instruction": {
                  "type": "string",
                  "description": "Agent-facing instruction explaining how to continue.",
                  "minLength": 1
                },
                "tools": {
                  "type": "array",
                  "description": "Allowed tool choices from which the agent must select one.",
                  "minItems": 1,
                  "uniqueItems": true,
                  "items": {
                    "type": "string",
                    "description": "Name of a tool the agent may choose.",
                    "minLength": 1
                  }
                }
              }
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "instruction"
              ],
              "properties": {
                "kind": {
                  "const": "RetryRequest",
                  "description": "Action required before the original request can continue."
                },
                "instruction": {
                  "type": "string",
                  "description": "Agent-facing instruction explaining how to continue.",
                  "minLength": 1
                }
              }
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "instruction"
              ],
              "properties": {
                "kind": {
                  "const": "ReviseRequest",
                  "description": "Action required before the original request can continue."
                },
                "instruction": {
                  "type": "string",
                  "description": "Agent-facing instruction explaining how to continue.",
                  "minLength": 1
                }
              }
            },
            {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "kind",
                "instruction"
              ],
              "properties": {
                "kind": {
                  "const": "ResolveExternally",
                  "description": "Action required before the original request can continue."
                },
                "instruction": {
                  "type": "string",
                  "description": "Agent-facing instruction explaining how to continue.",
                  "minLength": 1
                }
              }
            }
          ],
          "description": "Action the agent should take before retrying or continuing."
        },
        "diagnostics": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "description": "The diagnostic identifier.",
                "type": "string"
              },
              "severity": {
                "description": "The diagnostic severity.",
                "type": "string",
                "enum": [
                  "Hidden",
                  "Info",
                  "Warning",
                  "Error"
                ]
              },
              "message": {
                "description": "The diagnostic message.",
                "type": "string"
              },
              "location": {
                "description": "The optional source location of the diagnostic.",
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "document": {
                    "description": "The resolved document.",
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "documentId": {
                        "description": "The document identifier.",
                        "type": "string"
                      },
                      "path": {
                        "description": "The normalized document path.",
                        "type": "string"
                      },
                      "projectId": {
                        "description": "The owning project identifier.",
                        "type": "string"
                      }
                    },
                    "required": [
                      "documentId",
                      "path",
                      "projectId"
                    ]
                  },
                  "span": {
                    "description": "The resolved text span.",
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "start": {
                        "description": "Zero-based UTF-16 offset.",
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 2147483647
                      },
                      "length": {
                        "description": "UTF-16 code-unit length.",
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 2147483647
                      }
                    }
                  },
                  "line": {
                    "description": "The one-based line number.",
                    "type": "integer"
                  },
                  "column": {
                    "description": "The one-based column number.",
                    "type": "integer"
                  },
                  "snapshot": {
                    "description": "The exact immutable workspace snapshot associated with this location.",
                    "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"
                    ]
                  },
                  "selector": {
                    "description": "The canonical selector that can resolve this source location again.",
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "span": {
                        "type": "object",
                        "properties": {
                          "document": {
                            "description": "Provide exactly one of path or documentId.",
                            "type": "object",
                            "properties": {
                              "project": {
                                "description": "Disambiguates documents with matching paths or IDs.",
                                "type": [
                                  "object",
                                  "null"
                                ],
                                "properties": {
                                  "projectId": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "name": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "path": {
                                    "description": "Workspace-relative path.",
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  },
                                  "targetFramework": {
                                    "type": [
                                      "string",
                                      "null"
                                    ]
                                  }
                                }
                              },
                              "path": {
                                "description": "Workspace-relative path.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              },
                              "documentId": {
                                "description": "Workspace-local document ID.",
                                "type": [
                                  "string",
                                  "null"
                                ]
                              }
                            }
                          },
                          "range": {
                            "description": "Zero-based UTF-16 range.",
                            "type": "object",
                            "properties": {
                              "start": {
                                "description": "Zero-based UTF-16 offset.",
                                "type": "integer",
                                "minimum": 0,
                                "maximum": 2147483647
                              },
                              "length": {
                                "description": "UTF-16 code-unit length.",
                                "type": "integer",
                                "minimum": 0,
                                "maximum": 2147483647
                              }
                            }
                          }
                        },
                        "required": [
                          "document",
                          "range"
                        ]
                      }
                    },
                    "required": [
                      "span"
                    ]
                  }
                },
                "required": [
                  "snapshot"
                ]
              }
            },
            "required": [
              "id",
              "message"
            ]
          },
          "description": "Diagnostics that explain the failed invocation."
        },
        "warnings": {
          "type": "array",
          "description": "Non-fatal warnings the agent should consider.",
          "items": {
            "$ref": "#/$defs/warningInfo"
          }
        }
      }
    },
    {
      "type": "object",
      "required": [
        "ok",
        "error",
        "diagnostics"
      ],
      "properties": {
        "ok": {
          "const": false,
          "description": "Whether the tool invocation succeeded."
        },
        "error": {
          "type": "object",
          "required": [
            "code",
            "message",
            "correlationId"
          ],
          "properties": {
            "code": {
              "const": "UnhandledException"
            },
            "message": {
              "const": "Tool execution failed."
            },
            "correlationId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "description": "Structured error details when the invocation failed."
        },
        "diagnostics": {
          "type": "object",
          "required": [
            "detailsAvailable",
            "detailsTool"
          ],
          "properties": {
            "detailsAvailable": {
              "const": true
            },
            "detailsTool": {
              "const": "get-error-details"
            }
          },
          "description": "Diagnostics that explain the failed invocation."
        },
        "reporting": {
          "type": "object",
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "Available",
                "AlwaysApproved",
                "DisabledByConfiguration",
                "ApprovalUnavailable"
              ]
            },
            "canPrepare": {
              "type": "boolean"
            },
            "prepareTool": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "state"
          ],
          "description": "Error-reporting workflow available for an unhandled failure."
        }
      }
    }
  ],
  "$defs": {
    "warningInfo": {
      "type": "object",
      "properties": {
        "code": {
          "description": "The stable machine-readable warning code.",
          "type": "string"
        },
        "message": {
          "description": "The human-readable warning message.",
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

Machine reference