Skip to main content

describe_resource

Returns the output fields exposed by a resource's primary read method -- the columns the agent can SELECT. Use this when the agent needs to know what data shape will come back before writing the query.

For the full I/O contract of a specific method (inputs, output, request body), use describe_method.

See also: [ MCP overview ] [ list_resources ] [ describe_method ] [ run_select_query ]


Inputs

ArgumentRequiredDescription
providerYesProvider name.
serviceYesService under that provider.
resourceYesResource under provider.service.

Output

RendererShape
KVField name, type, and description for each output column on the primary read method

Gating

Allowed in every server mode. Read only.


Example

Try this prompt with any elicitation-capable MCP client with the StackQL MCP server registered:

What fields does a Google Storage bucket  
return when I query it?

Here's an example in Claude Desktop: