Skip to main content
Glama

form_get_json_object_schema

Retrieves the JSON object schema for a runnable item to generate a ProviderSchemaImpl, enabling creation of custom resource types.

Instructions

Get json object schema for runnable item. Generate a ProviderSchemaImpl for the provided RunnableItem. The schema can be used to create a custom resource type. POST /form-service/api/custom/schema-generation/json

Input Schema

NameRequiredDescriptionDefault
bodyYesRunnable item
externalTypeNoExternal type

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false and idempotentHint=false, and the description adds the POST endpoint and the generation/derivation nature of the call, which is useful framing. It is silent, though, on whether the call persists anything, whether the runnable item must pre-exist, or on the size/shape of the generated schema. The 'Get' phrasing mildly conflicts in tone with readOnlyHint=false, but the POST line clarifies it, so this is not a contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the outcome, then the mechanism, then the use case. Slight redundancy between 'Get json object schema' and 'Generate a ProviderSchemaImpl', and the raw endpoint path is filler for an agent, but nothing is padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a deeply nested body (inputBindings, inputParameters, outputParameters) and no output schema, the description should say more about the returned schema or how the RunnableItem fields map into it. It does convey the conceptual return value (a ProviderSchemaImpl), which keeps it above a 2, but the agent is left to guess at the response format and at how to successfully construct the request body.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is reported at 100%, so the baseline is 3. The description adds nothing about the two parameters: it does not say that 'body' is the RunnableItem being converted, nor what 'externalType' changes in the generated schema, so the agent must infer those semantics from the nested schema alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a concrete verb+result: generates a ProviderSchemaImpl JSON schema for a given RunnableItem, which can then be used to create a custom resource type. That is materially more specific than the tool name alone. It does not, however, distinguish itself from near-identical siblings such as form_generate_json_schema or form_generate_elements_runnable_item.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied through the clause 'can be used to create a custom resource type', which hints at the downstream workflow without naming the counterpart tool. There is no explicit when-to-use, when-not-to-use, or prerequisite (e.g. that a valid RunnableItem must already exist, obtainable from form_get_action_runnable_item).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools