Skip to main content
Glama

register_convention

Register a new convention when no existing one fits (check list_conventions first): a name (e.g. 'pet-grooming'), what its listings are about, and 5 to 9 dimensions as {field: what it means}. Don't repeat the trunk fields. If similar conventions exist you get them back; register again with confirm_new=true if none fits. A field name that's already registered keeps its registered meaning. Names are first come, first served; you can later add dimensions (up to 9) by registering the same name again, never rename or remove them.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesA new convention name, lowercase with dashes, e.g. 'pet-grooming'.
extendsNoThe convention it builds on (default: the trunk, 'need-can').need-can
api_tokenNoYour hashn API token, if you can't send it as the 'Authorization: Bearer <token>' header. Omit it when the header is set.
dimensionsYes5 to 9 fields as {field: what it means}. Don't repeat the trunk fields (name, description, need, can, contact_method, contact_info).
confirm_newNoSet true to register even though similar conventions exist.
descriptionYesWhat kind of work its listings are about.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / properties / api_token / description
      Added value: +"Your hashn API token, if you can't send it as the 'Authorization: Bearer <token>' header. Omit it when the header is set."
    • addedInput schema / properties / confirm_new / description
      Added value: +"Set true to register even though similar conventions exist."
    • addedInput schema / properties / description / description
      Added value: +"What kind of work its listings are about."
    • addedInput schema / properties / dimensions / description
      Added value: +"5 to 9 fields as {field: what it means}. Don't repeat the trunk fields (name, description, need, can, contact_method, contact_info)."
    • addedInput schema / properties / extends / description
      Added value: +"The convention it builds on (default: the trunk, 'need-can')."
    • addedInput schema / properties / name / description
      Added value: +"A new convention name, lowercase with dashes, e.g. 'pet-grooming'."
  2. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare it is a non-read-only, non-destructive local write. The description goes well beyond: names are first come first served, existing field names retain their registered meaning, dimensions can be added later by re-registering (up to 9) but never renamed or removed. This is genuine lifecycle behavior an agent needs.

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?

Front-loads the action, the required inputs, and the check-first rule; the trailing sentences about first-come-first-served and later expansion are dense but each carries a distinct constraint. Slightly long but no filler.

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, the description carries the return-value burden and does so ("If similar conventions exist you get them back"), while also covering constraints (don't repeat trunk fields, name uniqueness, dimension limits). Complete for a 6-param mutation tool.

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 is 3. The description adds real meaning on top: the semantics of confirm_new ("register again with confirm_new=true if none fits"), name immutability, and the 5-to-9 dimension range tied to the re-registration flow.

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 ("Register a new convention") and immediately scopes it against a named sibling ("check list_conventions first"). An agent can distinguish it from get_convention and list_conventions without opening any schema.

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 names when to use it ("when no existing one fits"), the prerequisite alternative (list_conventions), and the retry path ("register again with confirm_new=true if none fits"). Both the when and the fallback are spelled out.

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