Browse documentation

get_diagnostics

[symbols]

Read compiler errors and warnings with separate coverage evidence.

Unreleased read-only preview. Technical reference for agents and client integrators.

Before this call

Compiler errors are useful evidence. Inspect diagnosticCoverage and limitations before an absence claim.

Parameters

NameTypeRequiredDescription
pathstringNoOptional contained workspace file path.
modulestringNoExact imported module identifier.
scopestringNoCompiler scope.
includeWarningsbooleanNoInclude warning diagnostics. Default: true
limitnumberNoInteger from 1 to 500. Keep the value unchanged during pagination. Default: 100
cursorstringNoOpaque nextCursor from the same query and generation. Keep all query arguments unchanged.

Examples

Technical examples for agents and client integrators. Replace paths and opaque keys with returned workspace values.

Illustrative arguments

Arguments
{
  "scope": "main",
  "includeWarnings": false
}
Full MCP request
Full MCP request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_diagnostics",
    "arguments": {
      "scope": "main",
      "includeWarnings": false
    }
  }
}

Response notes

Results contain compiler-backed facts, contexts, coverage, limitations, and pagination. Maven TEST source is parser-only in this preview. Parser tools remain usable with an external Maven parent POM or a Gradle source producer. The affected compiler facts are unavailable. Pages default to 100 entries and permit 500. Follow nextCursor with unchanged arguments. Incomplete coverage cannot certify absence. For stale_snapshot, inspect server_status and stabilize the changed input. Call sync. After it succeeds, repeat declaration discovery and retry with the new key or cursor.