Skip to main content
Glama

Onboarding guide

onboarding_guide
Read-onlyIdempotent

Teaches session usage of ProactiveAgent memory tools: when to capture/recall/extract, confirm pending memories, and restraint principle. Run on first mount in a new environment.

Instructions

Cold-start guide: teaches this session how to use ProactiveAgent memory & suggestion tools (when to use memory_capture/recall/extract, how to confirm pending memories, restraint principle). Call once on first mount in a new environment/project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.10.0

TDQS

A4.7/5.0
Behavior4/5

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

ReadOnly and idempotent annotations already indicate safety; the description reinforces this by describing teaching rather than state changes. It does not add detail about side effects, but none are implied and the annotations cover it.

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?

Single concise sentence with clear front-loaded purpose and a direct usage condition. No wasted words or redundant elaboration.

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 parameterless, read-only instructional tool with an output schema, the description fully explains its content and invocation timing. 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?

With zero parameters, there is nothing to document. The description appropriately focuses on what the guide covers and when to invoke it, matching the baseline expectation for a parameterless tool.

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?

Clearly states it is a cold-start guide that teaches how to use ProactiveAgent memory and suggestion tools, distinguishing it from the actual tool siblings by framing it as instructional orientation rather than a data operation.

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 to call once on first mount in a new environment or project, giving a precise condition for use and implying it is not needed for routine operations.

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