Skip to main content
Glama
hvolckaert

helix-mcp-knowledge

by hvolckaert

get_sync_status

Read-onlyIdempotent

Check if the official index is ready and synchronized for a given or active project to ensure reliable evidence retrieval.

Instructions

Report official index readiness and synchronization state; project details are limited to the explicitly requested or active project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectNo
officialYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.29.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely new behavioral context: results are scoped to the explicitly requested project or the active project, which tells the agent how the query is implicitly filtered. It stops short of noting freshness, caching, or cost.

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?

A single compact sentence with the core purpose front-loaded before the scoping qualifier. No filler, though the semicolon clause is slightly terse and would read better as two clauses.

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?

With an output schema present, return values need not be described, and annotations cover the safety profile, so the remaining burden is small. Still, the description omits the sibling differentiation an agent needs and leaves the sole parameter's fallback semantics implicit.

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 coverage is 0% and the single parameter (project_id, optional, default null) is undocumented in the schema. The description partially compensates by implying the project falls back to the active project when not explicitly requested, but it never names the parameter or states the null fallback explicitly.

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?

States a specific verb ('Report') and resource ('official index readiness and synchronization state'), so the agent knows it is a status-read tool. However, it never distinguishes itself from the sibling get_update_status, which plausibly reports a closely related status, leaving the boundary to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use or when-not-to-use guidance, and no alternatives are named. The clause about project scope hints at invocation behavior but does not tell the agent when this tool is the right choice over get_update_status or get_active_project.

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