Skip to main content
Glama

AI prompt gap brief

get_prompt_gap_brief
Read-only

The gap brief for one AI prompt: the answer an assistant could quote, what the currently-cited pages have that this site doesn't, and the schema to add. null until win_prompt has run.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
prompt_idYesA tracked AI prompt id, from get_ai_visibility's prompt matrix or add_ai_prompt
project_idYesRanking id from list_projects

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
promptYes
verdictYes
allowanceYes
gap_briefYes
latest_runYes
project_idYes
gap_brief_atYes

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already mark this as read-only, and the description adds valuable non-obvious behavior: the result is null until win_prompt has run. It also discloses the output's three components (answer, gap versus cited pages, schema to add) without contradicting the annotations.

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?

The description is one dense, well-structured sentence: it names the resource, enumerates the three output components, and ends with the key null precondition. No filler, no redundancy.

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 an output schema present, return-value details are already covered. The description supplies the essential missing context: the dependency on win_prompt and what the brief conceptually contains. The two parameters are self-describing in the schema, so nothing needed for correct invocation is missing.

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%, with both project_id and prompt_id already explained in the schema. The description does not add parameter-level meaning beyond that, so the baseline score of 3 is appropriate.

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 clearly identifies the tool's output: a gap brief for one AI prompt containing a quotable answer, a comparison of cited pages versus the site, and the schema to add. It references win_prompt, which anchors its role, but it does not explicitly differentiate itself from related siblings like get_ai_citations or get_content_brief.

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?

The phrase 'null until win_prompt has run' gives a clear precondition, telling the agent this tool should be called only after win_prompt has executed. It provides useful temporal context, though it does not name alternatives or explicitly say 'use this instead of X'.

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.

TDQS

A3.7/5.0
Disambiguation3/5

Most tools are distinct get_* analytics, but several overlap in purpose: get_ai_visibility vs get_share_of_voice are easy to confuse, and get_project_overview/get_content_action_plan/get_audit_summary all offer prioritized fixes. Descriptions help, but an agent could easily misselect for a generic 'what should I fix?' query.

Naming Consistency5/5

All names follow a consistent snake_case verb_noun pattern (add_, get_, generate_, list_, analyze_, research_), and the get_* prefix dominates read operations. Even win_prompt is a verb_noun and fits the style.

Tool Count2/5

27 tools is past the 25+ threshold and creates a heavy selection surface for an agent. While the SEO/AI-visibility domain is broad, many tools return overlapping 'health/fix/visibility' data and the set would benefit from consolidation.

Completeness3/5

Core workflows (projects, keywords, content briefs, audits, backlinks, AI visibility) are covered, but lifecycle gaps exist: keywords and AI prompts can be added but not removed, there is no list-AI-prompts tool, and no project creation/update is exposed. These are workable but notable missing operations.

Resources