Skip to main content
Glama

Get conventions

layerz_get_conventions
Read-onlyIdempotent

Returns the conventions the tools' values are expressed in: custom_instructions (the conventions of a workspace, the standing instructions for AI agents its members share, ≤ 3000 chars, empty string when unset; also carried as conventions by the entry tools on a model), workspace ({ id, name, kind }: the targeted model's workspace when the caller is a member of it, else workspace_id, else the personal workspace) and, when a model is targeted, finance_md (the model's FINANCE.md: raw Markdown, source, spec_version, parsed front_matter with currency / units / sign convention / glossary, validation_errors; null when the model has none). include_guide: true adds guide, the modeling guide (session workflow, structure, stock-flow, lists, branches, sources, templates, checks, versions; also the resource modeling-guide://reference); include_formula_spec: true adds formula_spec, the formula language (functions, lags, list subscripts; also the resource formula-spec://reference), for a client that cannot read resources.

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

Input Schema

NameRequiredDescriptionDefault
model_idNoTarget model UUID. Required for user-scoped API keys; validated against the bound model for model-scoped keys.
workspace_idNoA workspace the caller belongs to (`layerz_list_models` lists them); default: personal.
include_guideNoAlso return the modeling guide (Markdown).
include_formula_specNoAlso return the formula language reference (Markdown).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / include_formula_spec
      Added value: +{
      +  "description": "Also return the formula language reference (Markdown).",
      +  "type": "boolean"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / workspace_id
      Added value: +{
      +  "description": "A workspace the caller belongs to (`layerz_list_models` lists them); default: personal.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
  3. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive and the description does not contradict them. It adds real behavioral context beyond them: the workspace resolution fallback order (membership → workspace_id → personal), null for missing finance_md, empty string for unset custom_instructions, the 3000-char cap, and the fact that entry tools also carry `conventions`. It stops short of covering error behavior, but the disclosure is well above the annotation bar.

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

Conciseness3/5

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

The purpose is front-loaded, which is good, but the entire body is a single dense paragraph with deeply nested parentheses enumerating return fields. Every fact is relevant, yet the structure makes it hard to scan; a short sentence on what is returned by default, followed by the optional blocks, would read far better.

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?

With no output schema and four optional parameters, the description must carry the return shape itself and it does — enumerating each returned field, its type, and its null/empty semantics. Nothing an agent needs in order to call this correctly or interpret the result 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?

Schema coverage is 100%, so the baseline would be 3, but the description adds meaning the schema does not: it explains what the include_guide and include_formula_spec flags actually inject into the response, and how workspace_id interacts with model membership and the personal-workspace default.

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?

The description opens with a specific verb+resource: it returns the conventions (custom instructions, workspace, FINANCE.md) that the tools' values are expressed in. That is clearly distinct from siblings like layerz_get_model or layerz_set_custom_instructions, though the tool never names those siblings to sharpen the boundary.

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?

When-to-use is only implied: the reader infers this is the read counterpart to layerz_set_custom_instructions / layerz_set_finance_md, and the description explains that include_guide/include_formula_spec exist 'for a client that cannot read resources' — a genuine conditional. But it never states exclusions or explicitly says when to prefer the MCP resources (modeling-guide://reference, formula-spec://reference) over this tool.

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.

Resources