Skip to main content
Glama
astandrik

Codex Pets

Get animated README card code

get_card_code
Read-onlyIdempotent

Generate animated README card Markdown, HTML, or GIF URL for an approved Codex pet. Requires the pet's exact slug.

Instructions

Use for a known approved pet slug when the user needs animated README card Markdown, HTML, or GIF URL. Do not use for simple badges, website iframe embeds, install instructions, or pet discovery; use get_badge_code, get_embed_code, get_install_instructions, or search_pets instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesExact slug of an approved public Codex pet.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedInput schema / properties / slug / description
      Previous value: -"Approved Codex pet slug."New value: +"Exact slug of an approved public Codex pet."
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already indicate safe, read-only, idempotent behavior. The description adds context that the input must be an 'approved' pet slug and that the output includes Markdown, HTML, or GIF URL, which is useful beyond the annotations.

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 concise sentences, front-loaded with the core purpose and conditional usage. No wasted words.

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 the simple tool (one parameter, rich annotations, no output schema), the description sufficiently covers input and output types. It could mention the exact format of the returned code but is complete enough for selection and invocation.

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 coverage is 100% and the parameter 'slug' is well-described in the schema. The description reinforces the requirement ('known approved pet slug') but does not add significant new 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 clearly states the tool's purpose: retrieving animated README card code (Markdown, HTML, or GIF URL) for a known approved pet slug. It distinguishes itself from siblings by listing specific alternative tools for other use cases.

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 provides explicit guidance on when to use (for a known approved pet slug needing animated README card code) and when not to use (badges, embeds, install instructions, pet discovery), with named alternative tools.

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