Skip to main content
Glama

Record a gap

record_gap

Records a skill a job offer requires but your profile lacks, adding it to a gap radar with source and count; creates new entries and avoids duplicates.

Instructions

Records that a job offer asks for a skill the user does NOT have. If the term is already in the radar its count goes up by one and the source is added; otherwise it is created with count 1. It never duplicates. Call it once per skill the offer asks for that is missing from the user's profile, including terms the user could not define in an interview. Never call it for something already in skills.md.

Input Schema

NameRequiredDescriptionDefault
termYesThe missing skill or concept, named the way an engineer would. E.g. 'Kubernetes'.
sourceYesOffer that asks for it, so it can be traced. E.g. 'Acme Backend Engineer, Remote'.
categoryYesCategory it belongs to, used to place it under the right '##' heading in the profile once it graduates. E.g. 'Infrastructure'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only declare idempotentHint=false and destructiveHint=false; the description adds the meaningful part by explaining the upsert semantics -- count increments and source is appended if the term exists, otherwise it is created with count 1 -- and that duplicates are never produced. It does not cover permissions, the response shape, or how the added source affects the existing entry, but the mutation consequences are well disclosed and consistent with the non-idempotent hint.

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?

The purpose and mutation behavior are front-loaded in the first three sentences, with usage rules following. Five sentences is on the long side for a three-parameter tool, and 'It never duplicates' partially overlaps with the later 'Never call it for something already in skills.md', but every sentence still carries actionable information.

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?

For a mutation tool with no output schema and only partial annotation coverage (idempotency/destructiveness), the description supplies the core context an agent needs: the missing-skill scope, the create-vs-increment behavior, and the exclusion for skills already in the profile. Remaining gaps -- return value and any auth/permission requirement -- are minor for this operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so term, source, and category are all already documented with examples in the schema. The description only implicitly reinforces what 'source' does (it is added to an existing entry), adding no format, naming, or placement detail beyond the schema. Baseline 3 applies when the schema carries the parameter burden.

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?

The description opens with a precise verb+resource+condition: it records that a job offer asks for a skill the user does NOT have. It also discloses the underlying data behavior (radar entry incremented vs. created with count 1), which distinguishes it clearly from siblings like list_gaps or confirm_skill.

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?

It gives explicit when-to-use ('call it once per skill the offer asks for that is missing from the user's profile, including terms the user could not define in an interview') and an explicit when-not ('Never call it for something already in skills.md'). However, it never names the alternative sibling tools an agent should route to for already-known skills (e.g. confirm_skill or update_skill_level), so the exclusion lacks a destination.

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