Skip to main content
Glama

begin_project_sync

Idempotent

Begin a bounded hosted graph synchronization with four plain-language changeNarrative sections written manually by the publishing agent.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
sessionIdNo
executionIdNo
idempotencyKeyYes
mappedRevisionNo
changeNarrativeYes
declaredEdgeCountYes
declaredNodeCountYes
declaredChunkCountYes
declaredProseBytesYes
declaredCanonicalBytesYes
expectedProjectVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.6/5.0
Behavior2/5

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

Annotations already indicate readOnlyHint=false, destructiveHint=false, and idempotentHint=true. The description adds little beyond 'bounded' and that the narrative sections are written manually; it does not explain side effects such as session creation, validation behavior, or how idempotency is applied. It does not contradict annotations.

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 description is a single sentence, front-loaded with the core verb and resource, and it includes a useful constraint about the narrative sections. It is concise without wasted words, though it could be better structured by separating the concept from the writing requirement.

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

Completeness1/5

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

This is a 12-parameter, mutation-oriented tool with a nested object, no output schema, and no parameter descriptions. The description does not explain the sync workflow, prerequisites, validation of declared counts, or the relationship to sibling tools. It is far from sufficient for an agent to invoke it correctly in context.

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

Parameters2/5

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

Schema description coverage is 0%, so the description should compensate, but it only clarifies that changeNarrative has four plain-language sections. It leaves the many count declarations, expectedProjectVersion, idempotencyKey, projectId, and other parameters unexplained. Some property names are self-explanatory, but the nested object and synchronization constraints need more guidance.

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 states a specific verb ('Begin') and resource ('hosted graph synchronization'), and adds useful qualifiers: 'bounded' and 'four plain-language changeNarrative sections'. This makes the tool's role clearer than the name alone, though it does not explicitly contrast with sibling sync tools.

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?

No guidance is given about when to use this tool versus related siblings like append_project_sync_chunk, commit_project_sync, seal_project_sync, or abort_project_sync. The phrase 'Begin' implies it is the starting point, but that is essentially restating the tool name and leaves the workflow context implicit.

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