Skip to main content
Glama

Get Reference

get_reference
Read-onlyIdempotent

Read version-matched pyside-iconify usage references before writing code, including exact signatures, accepted values, examples, and common mistakes.

Instructions

Read the authoritative, version-matched usage of pyside-iconify: exact signatures, accepted values, working examples and a table of common mistakes. Call it before writing pyside-iconify code; start with topic 'overview'. Call without a topic to list the topics.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_reference"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicNoTopic to read. Omit to list all topics.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, closed-world), so the description's job is to add context, which it does: content is version-matched and authoritative, and omitting the topic yields a topic list rather than an error. The only missing piece is guidance on what to expect from a returned topic entry, which the output schema likely covers.

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?

Three short clauses, front-loaded with the value proposition (authoritative, version-matched) followed by the call-to-action and the fallback mode. Nothing is redundant or padded.

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 optional-enum documentation reader with an output schema and full annotations, the description covers what the tool returns, how to start, and what happens with no argument. Nothing an agent needs in order to call it correctly 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 coverage is 100% and the enum already lists all nine topics, so the schema carries most of the burden. The description still adds value by recommending 'overview' as the first topic and by confirming that omitting the parameter lists topics, which explains the nullable default in practical terms.

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?

States a specific verb (Read) and a precise resource (authoritative, version-matched reference for pyside-iconify), and enumerates what the resource contains: exact signatures, accepted values, working examples, common-mistake table. That content profile makes it clearly distinct from search_icons, check_icons, and check_code without needing to name them.

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

Usage Guidelines4/5

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

Gives explicit sequencing guidance ('Call it before writing pyside-iconify code') and a concrete entry point ('start with topic overview'), plus a documented no-argument mode that lists topics. It stops short of stating when to prefer the sibling tools (search_icons/check_code) over this one, so it is strong but not fully exhaustive.

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