Skip to main content
Glama

Get Tool Schema

get_tool_schema
Read-onlyIdempotent

Need the exact input and output schema for a Huly tool? Use this to retrieve the required argument names and result shape before calling invoke_tool.

Instructions

Returns the exact input and output schema for one proxy-visible Huly tool. Use this before invoke_tool when you are not certain about required argument names or result shape.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolNameYesExact Huly tool name from search_tools or list_tool_categories results.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
warningsNoOptional agent-visible warnings about degraded result fidelity or important operational conditions. Omitted when there is nothing the agent needs to surface.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.44.11
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded",
      -  "hosted_huly_shutdown",
      -  "issue_label_metadata_degraded",
      -  "issue_milestone_metadata_degraded",
      -  "notification_metadata_degraded",
      -  "card_version_metadata_degraded",
      -  "issue_creator_metadata_degraded",
      -  "recruiting_review_metadata_degraded",
      -  "issue_relation_metadata_degraded",
      -  "class_collaborator_metadata_degraded",
      -  "planner_document_metadata_degraded",
      -  "external_channel_runtime_unsupported",
      -  "support_runtime_unsupported",
      -  "support_status_metadata_degraded",
      -  "workbench_navigation_metadata_degraded",
      -  "lead_customer_metadata_degraded",
      -  "calendar_meeting_room_metadata_degraded",
      -  "recruiting_candidate_custom_field_metadata_degraded",
      -  "custom_field_metadata_degraded"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown",
      +  "issue_label_metadata_degraded",
      +  "issue_milestone_metadata_degraded",
      +  "notification_metadata_degraded",
      +  "card_version_metadata_degraded",
      +  "issue_creator_metadata_degraded",
      +  "recruiting_review_metadata_degraded",
      +  "issue_relation_metadata_degraded",
      +  "class_collaborator_metadata_degraded",
      +  "planner_document_metadata_degraded",
      +  "external_channel_runtime_unsupported",
      +  "support_runtime_unsupported",
      +  "support_status_metadata_degraded",
      +  "workbench_navigation_metadata_degraded",
      +  "lead_customer_metadata_degraded",
      +  "calendar_meeting_room_metadata_degraded",
      +  "recruiting_candidate_custom_field_metadata_degraded",
      +  "custom_field_metadata_degraded",
      +  "external_publication_target_metadata_degraded"
      +]
  2. Changed1 schema field changedv0.44.9
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded",
      -  "hosted_huly_shutdown",
      -  "issue_label_metadata_degraded",
      -  "issue_milestone_metadata_degraded",
      -  "notification_metadata_degraded",
      -  "card_version_metadata_degraded",
      -  "issue_creator_metadata_degraded",
      -  "recruiting_review_metadata_degraded",
      -  "issue_relation_metadata_degraded",
      -  "class_collaborator_metadata_degraded",
      -  "external_channel_runtime_unsupported",
      -  "support_runtime_unsupported",
      -  "support_status_metadata_degraded",
      -  "workbench_navigation_metadata_degraded"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown",
      +  "issue_label_metadata_degraded",
      +  "issue_milestone_metadata_degraded",
      +  "notification_metadata_degraded",
      +  "card_version_metadata_degraded",
      +  "issue_creator_metadata_degraded",
      +  "recruiting_review_metadata_degraded",
      +  "issue_relation_metadata_degraded",
      +  "class_collaborator_metadata_degraded",
      +  "planner_document_metadata_degraded",
      +  "external_channel_runtime_unsupported",
      +  "support_runtime_unsupported",
      +  "support_status_metadata_degraded",
      +  "workbench_navigation_metadata_degraded",
      +  "lead_customer_metadata_degraded",
      +  "calendar_meeting_room_metadata_degraded",
      +  "recruiting_candidate_custom_field_metadata_degraded",
      +  "custom_field_metadata_degraded"
      +]
  3. Changed18 schema fields changedv0.44.6
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $defs / NonEmptyTrimmedString
      Removed value: -{
      -  "description": "a non empty string",
      -  "minLength": 1,
      -  "pattern": "^\\S[\\s\\S]*\\S$|^\\S$|^$",
      -  "title": "nonEmptyString",
      -  "type": "string"
      -}
    • removedOutput schema / properties / result / properties / annotations / properties / title / $ref
      Removed value: -"#/$defs/NonEmptyTrimmedString"
    • addedOutput schema / properties / result / properties / annotations / properties / title / minLength
      Added value: +1
    • addedOutput schema / properties / result / properties / annotations / properties / title / pattern
      Added value: +"^\\S[\\s\\S]*\\S$|^\\S$|^$"
    • addedOutput schema / properties / result / properties / annotations / properties / title / type
      Added value: +"string"
    • removedOutput schema / properties / result / properties / annotations / required
      Removed value: -[]
    • removedOutput schema / properties / result / properties / category / $ref
      Removed value: -"#/$defs/ToolCategory"
    • addedOutput schema / properties / result / properties / category / allOf
      Added value: +[
      +  {
      +    "$ref": "#/$defs/ToolCategory"
      +  }
      +]
    • addedOutput schema / properties / result / properties / category / description
      Added value: +"MCP tool category used for toolset filtering and proxy discovery."
    • removedOutput schema / properties / result / properties / description / $ref
      Removed value: -"#/$defs/ToolDescription"
    • addedOutput schema / properties / result / properties / description / allOf
      Added value: +[
      +  {
      +    "$ref": "#/$defs/ToolDescription"
      +  }
      +]
    • addedOutput schema / properties / result / properties / description / description
      Added value: +"Human-readable MCP tool description."
    • removedOutput schema / properties / result / properties / inputSchema / title
      Removed value: -"unknown"
    • removedOutput schema / properties / result / properties / name / $ref
      Removed value: -"#/$defs/ToolName"
    • addedOutput schema / properties / result / properties / name / allOf
      Added value: +[
      +  {
      +    "$ref": "#/$defs/ToolName"
      +  }
      +]
    • addedOutput schema / properties / result / properties / name / description
      Added value: +"Exact MCP tool name registered by this server."
    • removedOutput schema / properties / result / properties / outputSchema / title
      Removed value: -"unknown"
  4. Changed1 schema field changedv0.44.5
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded",
      -  "hosted_huly_shutdown",
      -  "issue_label_metadata_degraded",
      -  "issue_milestone_metadata_degraded",
      -  "notification_metadata_degraded",
      -  "card_version_metadata_degraded",
      -  "issue_creator_metadata_degraded",
      -  "recruiting_review_metadata_degraded",
      -  "issue_relation_metadata_degraded",
      -  "class_collaborator_metadata_degraded",
      -  "external_channel_runtime_unsupported"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown",
      +  "issue_label_metadata_degraded",
      +  "issue_milestone_metadata_degraded",
      +  "notification_metadata_degraded",
      +  "card_version_metadata_degraded",
      +  "issue_creator_metadata_degraded",
      +  "recruiting_review_metadata_degraded",
      +  "issue_relation_metadata_degraded",
      +  "class_collaborator_metadata_degraded",
      +  "external_channel_runtime_unsupported",
      +  "support_runtime_unsupported",
      +  "support_status_metadata_degraded",
      +  "workbench_navigation_metadata_degraded"
      +]
  5. Changed1 schema field changedv0.44.4
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded",
      -  "hosted_huly_shutdown",
      -  "issue_label_metadata_degraded",
      -  "issue_milestone_metadata_degraded",
      -  "notification_metadata_degraded",
      -  "card_version_metadata_degraded",
      -  "issue_creator_metadata_degraded"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown",
      +  "issue_label_metadata_degraded",
      +  "issue_milestone_metadata_degraded",
      +  "notification_metadata_degraded",
      +  "card_version_metadata_degraded",
      +  "issue_creator_metadata_degraded",
      +  "recruiting_review_metadata_degraded",
      +  "issue_relation_metadata_degraded",
      +  "class_collaborator_metadata_degraded",
      +  "external_channel_runtime_unsupported"
      +]
  6. Changed1 schema field changedv0.44.3
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded",
      -  "hosted_huly_shutdown"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown",
      +  "issue_label_metadata_degraded",
      +  "issue_milestone_metadata_degraded",
      +  "notification_metadata_degraded",
      +  "card_version_metadata_degraded",
      +  "issue_creator_metadata_degraded"
      +]
  7. Changed2 schema fields changedv0.44.2
    • changedOutput schema / properties / warnings / description
      Previous value: -"Optional agent-visible warnings about degraded result fidelity. Omitted when the server returned the documented happy-path payload."New value: +"Optional agent-visible warnings about degraded result fidelity or important operational conditions. Omitted when there is nothing the agent needs to surface."
    • changedOutput schema / properties / warnings / items / properties / code / enum
      Previous value: -[
      -  "status_metadata_unresolved",
      -  "space_role_assignments_degraded",
      -  "message_template_metadata_degraded",
      -  "viewlet_descriptor_metadata_degraded",
      -  "space_preference_metadata_degraded",
      -  "approval_request_person_metadata_degraded",
      -  "approval_request_count_metadata_degraded"
      -]New value: +[
      +  "status_metadata_unresolved",
      +  "space_role_assignments_degraded",
      +  "message_template_metadata_degraded",
      +  "viewlet_descriptor_metadata_degraded",
      +  "space_preference_metadata_degraded",
      +  "approval_request_person_metadata_degraded",
      +  "approval_request_count_metadata_degraded",
      +  "hosted_huly_shutdown"
      +]
  8. Addedv0.44.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context: it returns the schema for 'one proxy-visible Huly tool' and is meant to be used before invoke_tool. It doesn't describe edge cases like unknown tool names, but the annotations carry the main burden, so a 4 is appropriate.

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

Conciseness5/5

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

Two sentences with no filler. The primary function is stated first, and the usage guidance is front-loaded in the second sentence. Every word earns its place.

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

Completeness5/5

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

For a single-parameter, read-only, idempotent tool with a full output schema, the description is complete. It tells the agent what the tool returns, when to use it, and where to get the parameter value. Nothing essential is missing.

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

Parameters4/5

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

Schema description coverage is 100%, so the schema already documents the single parameter toolName. The description adds value by specifying that the name must come from search_tools or list_tool_categories results, which is beyond the schema's generic 'Exact Huly tool name' phrasing. This is a meaningful addition, though the schema already does most of the work.

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

Purpose5/5

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

The description states a specific verb ('Returns') and resource ('exact input and output schema for one proxy-visible Huly tool'), clearly distinguishing it from sibling tools like search_tools and list_tool_categories. It also names the sibling invoke_tool, making the tool's purpose unmistakable.

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

Usage Guidelines5/5

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

The description explicitly says 'Use this before invoke_tool when you are not certain about required argument names or result shape,' providing a clear when-to-use condition and naming the alternative tool. This is exactly the kind of routing guidance an agent needs.

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