Skip to main content
Glama

example_script

Return a ready-made training script for launch_training or hf_job_launch; omit the name to list available LLM, RL, and CV examples.

Instructions

Return a ready-made training script to pass to launch_training / hf_job_launch.

With no name it lists the examples (LLM LoRA fine-tune, RL PPO, CV CNN). Each script's header says how to launch it and which settings it accepts.

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": "example_script"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the burden: it discloses that omitting the name switches to list mode and that each script header documents launch instructions and accepted settings. It does not say what happens for an unrecognized name, nor explicitly confirm this is a no-side-effect read.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short paragraphs, front-loaded with the purpose before the no-argument branch. The line-wrapping and the slightly indirect phrase 'Each script's header says how to launch it' cost a little crispness but nothing is wasted.

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?

This is a simple one-parameter, read-only generator with an output schema, so return values need not be explained. The description covers naming the intended consumer, the listing mode, and where settings documentation lives — everything needed to invoke it correctly.

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 0%, so the description must compensate, and it does: it explains the empty-default branch ('With no name it lists the examples') and enumerates the likely accepted values. It stops short of stating the exact identifier strings or any validation behavior.

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 and resource: returns a ready-made training script, or lists available examples when no name is given. The three example names (LLM LoRA fine-tune, RL PPO, CV CNN) make the resource concrete and it is clearly distinguishable from the launcher siblings it feeds.

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?

Explicitly routes the agent: the output is meant to be passed to launch_training / hf_job_launch, which tells the agent where this fits in the workflow. It does not state when not to use it (e.g. when writing a custom script from scratch), so it stops short of full when/when-not guidance.

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