Skip to main content
Glama

Get Example Script

get_example
Read-onlyIdempotent

Get a small, valid worked example script for a bot type to use as a starting point.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
botTypeYesThe bot type. HTTP is a Protocol Bot script, BROWSER is a Browser Bot script, and PLAYWRIGHT is a Playwright script. "Browser script" is ambiguous: Browser Bot and Playwright are different types, so if the user's wording doesn't say which, ask before creating.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / botType / description
      Previous value: -"The bot type: HTTP, BROWSER, or PLAYWRIGHT."New value: +"The bot type. HTTP is a Protocol Bot script, BROWSER is a Browser Bot script, and PLAYWRIGHT is a Playwright script. \"Browser script\" is ambiguous: Browser Bot and Playwright are different types, so if the user's wording doesn't say which, ask before creating."
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description adds the useful trait that the returned content is a small, valid worked example, but says nothing about size limits, language, or what the example contains. Adds modest value over 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?

A single front-loaded sentence with no filler; every word (small, valid, worked example, starting point) earns its place and sets expectations for the output.

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?

For a one-parameter, read-only lookup whose safety is covered by annotations, the description is nearly complete. The only gap is that no output schema exists and the description only loosely characterizes the returned script (small, valid), leaving exact format to inference.

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 enum values and the Browser-vs-Playwright ambiguity warning are fully documented in the schema itself. The description adds nothing about the botType parameter, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Get) and resource (a small, valid worked example script) scoped by bot type. It reads clearly as distinct from get_script (a user's actual script) and get_scripting_api, though it never explicitly names those siblings.

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?

'To use as a starting point' implies a scaffolding/template use case, but there is no explicit when-to-use guidance or routing against alternatives like get_script or create_script. Usage is only inferable.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.