Skip to main content
Glama

Valem spec guide

valem_spec_guide
Read-onlyIdempotent

How to write a Valem ModelSpec that render_model accepts: sections, path notation, JSONata rules, view components and common mistakes. Call this once before writing your first spec in a conversation.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds the useful behavioral note that it is a once-per-conversation reference lookup, but says nothing about output shape or size, which matters for a knowledge-retrieval tool.

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 sentences, both earning their place: the first defines content, the second defines timing. The purpose and the call-condition are front-loaded with no filler.

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?

With no output schema, the description compensates by enumerating the topics the guide covers, which is enough for an agent to decide to call it. A brief note on the form of the returned guidance (e.g., structured sections vs prose) would close the remaining gap.

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?

The tool takes zero parameters and the schema is empty, so there is nothing for the description to disambiguate. Baseline 4 applies; no parameter-level claims are made or needed.

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 concrete resource and payload: guidance for writing a Valem ModelSpec that render_model accepts, enumerating sections, path notation, JSONata rules, view components and common mistakes. Naming render_model as the consumer distinguishes it from siblings like validate_spec, test_spec and get_domain_guidance.

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?

Gives explicit timing guidance: 'Call this once before writing your first spec in a conversation,' which sets both the trigger and the frequency. It does not, however, distinguish this from adjacent reference/validation siblings (validate_spec, test_spec, get_domain_guidance), so routing among those is left to inference.

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.