Skip to main content
Glama
Koodattu

wow-addon-api-mcp

by Koodattu

get_widget_methods

Read-onlyIdempotent

Retrieve public methods of a World of Warcraft widget for a selected patch and channel, with the option to include inherited methods.

Instructions

Get a ScriptObject or FrameXML intrinsic widget and its public methods in one patch in the selected channel.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesWidget name such as Frame, AuraButton, or AuraContainer
channelYesGame channel; never inferred from a version number
versionYesPatch, full client build, build number, or latest within the selected channel
include_inheritedNoInclude methods inherited from documented parent widgets

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.0
    • addedInput schema / properties / channel
      Added value: +{
      +  "description": "Game channel; never inferred from a version number",
      +  "enum": [
      +    "retail",
      +    "forever"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / version / description
      Previous value: -"Retail patch, full client build, build number, or latest"New value: +"Patch, full client build, build number, or latest within the selected channel"
    • addedInput schema / properties / version / minLength
      Added value: +1
    • changedInput schema / required
      Previous value: -[
      -  "name"
      -]New value: +[
      +  "name",
      +  "channel",
      +  "version"
      +]
  2. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description's 'Get' is consistent with those. It adds useful context that the result is pinned to a single patch/channel, but it does not describe return shape, pagination, or any special caveats beyond what annotations provide.

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?

A single, front-loaded sentence states the action, resource, and scope without filler. Every phrase carries information: widget type, public methods, one patch, selected channel.

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

Completeness4/5

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

Given a fully documented schema, read-only annotations, and a description that states both the returned content (widget and public methods) and version/channel scope, the definition is sufficient for a lookup tool. There is no output schema, but the expected output is clear enough from the description and tool name.

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 100%, so the parameters are already fully documented with names, examples, defaults, and enum constraints. The description adds no parameter-level meaning beyond the schema.

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 opens with the verb 'Get' and names a precise resource: a ScriptObject or FrameXML intrinsic widget plus its public methods. It also constrains the scope to one patch in the selected channel, which visibly separates it from sibling tools like compare_api, diff_versions, and generic lookup_api/resource tools.

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?

The phrasing implies the tool is for retrieving widget API methods at a specific version/channel, but it never states when to prefer it over alternatives or when not to use it. No sibling tool or exclusion is mentioned, so the agent has to infer selection from the word 'widget.'

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