Skip to main content
Glama
tandryukha

aidemo

by tandryukha
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Get the aidemo authoring guide

get_authoring_guide
Read-only

Retrieve the canonical authoring guide for demo storyboards, covering schema, actions, and recording principles. Use it before creating or editing storyboards to ensure correct structure.

Instructions

The canonical guide to authoring demos: storyboard schema, action vocabulary, demo-director principles, ChatGPT-app recording facts. Call this FIRST before authoring or editing a storyboard. Pass topic (core | schema | polish | attention | chatgpt-apps | stills | variants | captions | debug | ci, or any H2 heading prefix) for one slice instead of the whole ~1000-line guide; start with core, then fetch attention/polish/chatgpt-apps as needed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoSlice: core, schema, polish, attention, chatgpt-apps, stills, variants, captions, debug, ci — or an H2 heading prefix. Omit for the full guide.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
guideYes
topicNo
topicsYes
sectionsYes
engineVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.14.1
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / topic
      Added value: +{
+  "description": "Slice: core, schema, polish, attention, chatgpt-apps, stills, variants, captions, debug, ci — or an H2 heading prefix. Omit for the full guide.",
+  "type": "string"
+}
    • addedOutput schema / properties / sections
      Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / topic
      Added value: +{
+  "type": "string"
+}
    • addedOutput schema / properties / topics
      Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • changedOutput schema / required
      Previous value: -[
-  "guide",
-  "engineVersion"
-]New value: +[
+  "guide",
+  "engineVersion",
+  "topics",
+  "sections"
+]
  2. First observedv0.9.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, so the description needn't repeat safety. It adds behavioral context beyond that: the guide is ~1000 lines, supports partial retrieval via a topic slice, and allows H2 heading prefixes. This helps the agent anticipate response size and fetch strategy. No contradiction.

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 well-structured sentences. The purpose and usage are front-loaded, and the parameter explanation is compact but complete. No wasted words; every clause 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 simple read-only guide tool with one optional parameter and an output schema, the description fully covers what an agent needs: what it returns, how to invoke it, and when to use it. 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 coverage is 100% (topic is fully described in the schema). The description adds value by recommending which slices to start with and noting that any H2 prefix works, enriching the schema's enumeration. This goes beyond the baseline, so a 4 is warranted.

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: 'The canonical guide to authoring demos' and enumerates its contents (storyboard schema, action vocabulary, etc.). It differentiates from siblings by positioning itself as the first call before authoring, and its specificity ('canonical', 'FIRST') leaves no ambiguity about what it does.

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?

Explicitly instructs when to use: 'Call this FIRST before authoring or editing a storyboard.' It also provides a recommended sequence ('start with core, then fetch attention/polish/chatgpt-apps as needed') and explains the slicing behavior. This gives clear, actionable guidance for an agent.

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