Skip to main content
Glama

demonstration_plan

Read-onlyIdempotent

Get an ordered demonstration plan, then carry out each step in sequence, substituting IDs from earlier results. Use read_only or read_write to test tool descriptions and report errors/coverage.

Instructions

Return an ordered plan for demonstrating this server - which YOU then carry out.

    This hands back a list of steps; it does not run them. Call the tools it names, in
    order, substituting ids from earlier steps where a placeholder says so. That is
    the point: the plan tests whether the tool descriptions are good enough to use,
    and a tool that ran everything itself would have demonstrated nothing.

    `mode` is `read_only` (the default) or `read_write`.

      read_only    changes nothing. Safe against the production organization, which
                   is what these credentials reach.
      read_write   also creates and deletes CONTENT - a course, a quiz, a question
                   bank. Never a learner, a publication or a credential. Every write
                   is paired with a cleanup step.

    The plan also reports, before you start:
      * which steps THIS install's profile will refuse, so you can say what is being
        skipped rather than walking into it
      * coverage as `exercised` of `registered`, computed from the live tool registry
        so a newly added tool appears as a gap
      * which tools are deliberately excluded, each with its reason

    When you finish, report two facts SEPARATELY: whether anything errored, and how
    many tools were exercised. A run that did nothing also has no errors.

    Learner steps use named accounts only. Do not substitute a broad listing - the
    organization holds tens of thousands of real people and a transcript outlives the
    demo.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoread_only

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Install Server

TDQS

A5/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=true, idempotentHint=true), the description explains that even in read_write mode the tool itself does not execute writes—the plan contains paired create/delete steps. It also discloses that the plan reports refused steps, coverage gaps, and excluded tools. No contradiction with 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?

Although long, the description is tightly organized with clear sections, bolded mode names, and bullet points. Every sentence adds necessary operational detail—execution order, coverage reporting, exclusions, final reporting, and the learner-account caution. Nothing is redundant.

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 tool of this complexity, the description covers purpose, mode semantics, execution instructions, reporting expectations, and safety constraints. The presence of an output schema means the return format need not be described in prose. The warning about tens of thousands of real people is a critical real-world detail.

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

Parameters5/5

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

The schema only shows mode with a default and no enum. The description fully defines both values: 'read_only changes nothing' and 'read_write also creates and deletes CONTENT', plus cleanup pairing. This is exactly the meaning an agent needs and goes well beyond the bare 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 states precisely what the tool does: 'Return an ordered plan for demonstrating this server' and clarifies the plan is executed by the agent, not the tool. It distinguishes this meta-tool from the many sibling CRUD and read tools by explaining it returns steps rather than performing operations.

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 gives explicit instructions on how to use the plan: 'Call the tools it names, in order, substituting ids from earlier steps where a placeholder says so.' It also details mode-specific behavior, what the plan reports, and how to report results at the end. The warning about learner steps provides concrete guidance on what not to do.

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

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CloudSecurityAlliance/csa-skilljar'

If you have feedback or need assistance with the MCP directory API, please join our Discord server