Skip to main content
Glama

Sync opportunity backlog

opportunities.sync

Upserts local Grow topChanges and live GSC ranked findings into a Cloud backlog; accepts projectRoot or item lists and returns status counts.

Instructions

Pro: upsert grow topChanges and/or live GSC ranked opportunities into the Cloud backlog. Pass projectRoot to run local grow, or items. Returns counts by status (found N). Requires QUALITYKIT_API_KEY + QUALITYKIT_API_BASE.

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": "opportunities.sync"
  }
}

Input Schema

NameRequiredDescriptionDefault
itemsNoOptional grow-like items; omit to grow from projectRoot or sync GSC only
apiKeyNo
siteUrlNo
mergeGscNoMerge live GSC ranked opportunities (default true)
apiBaseUrlNo
projectRootNoAbsolute repo root — when set, runs local qualitykit.grow and syncs topChanges

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description must carry the full behavioral burden. It discloses the mutation nature (upsert), the required environment variables (QUALITYKIT_API_KEY + QUALITYKIT_API_BASE), and the return shape (counts by status, 'found N'). It does not state idempotency, what happens to non-matching existing backlog entries, or failure behavior for a write operation.

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?

Four short sentences, front-loaded with the action and the two input modes, with the return shape and prerequisites trailing correctly. Some density in 'upsert grow topChanges' hurts readability but nothing is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter, annotation-free sync tool this covers action, modes, auth, and return shape, which is the essential core. It leaves the 11-field item object and siteUrl scoping unexplained, so an agent must read the schema to construct valid input.

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 50%, so the schema documents mergeGsc and projectRoot but leaves items, apiKey, apiBaseUrl, and siteUrl undocumented. The description adds meaning for projectRoot (runs local qualitykit.grow and syncs topChanges) and implies the items-vs-GSC choice via 'and/or', but never explains siteUrl scoping or the apiKey/apiBaseUrl fallback beyond the env-var note.

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 names a specific verb (upsert) and target (Cloud opportunity backlog), plus the two source modes (local grow via projectRoot, or explicit items, optionally merged with live GSC). It distinguishes itself from opportunities.list/update by being a bulk ingestion operation, though the jargon 'grow topChanges' assumes familiarity with the qualitykit.grow sibling.

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?

It does give a concrete routing rule — pass projectRoot to run local grow, or supply items — which is real usage guidance. It never says when NOT to use this tool (e.g. use opportunities.update for single edits, or qualitykit.grow to inspect changes first), and offers no prerequisites beyond env vars.

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