JSONPad documentation

Validate a schema sync document

validate_sync_document

Read-onlyIdempotent

Check a schema sync document (sync-v1) as far as possible without an account: against the JSON schema the API uses, the API's rules for keys and indexes, and every rule set and flow in it with their tests. Documents that reference files (rulesFile, flowFile and their tests) are checked too if the files' contents are given in files. What a sync would change needs the account: the API server's plan_schema_sync, or jsonpad sync-schema --dry-run.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "document": "<document>"
    },
    "name": "validate_sync_document"
  }
}

Input Schema

Name	Required	Description	Default
`files`	No	The contents of files the document references, keyed by the path written in the document, e.g. { "rules/games.rules": "allow ..." }
`document`	Yes	The schema sync document

Output Schema

Name	Required	Description	Default
`ok`	Yes
`problems`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedSep 30, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the bar is lower. The description adds meaningful scope context by listing the account-free boundaries and pointing to account-requiring alternatives, which the annotations do not convey.

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?

Three sentences that are front-loaded with the core action and then progressively add scope and boundaries. It is dense but each clause adds information; the parenthetical tooling list is slightly list-like but justified.

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 validation tool with rich annotations, a 2-param schema at full coverage, and an output schema present, the description covers what is validated and what cannot be validated without an account. Return-format details are correctly left to the output schema.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already documents 'document' and 'files'. The description adds value by clarifying that document can carry file references (rulesFile, flowFile and their tests) and that those are only checked if the file contents are supplied via files, which is semantic context beyond the schema's type definitions.

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 states a specific verb (validate/check) and resource (schema sync document, sync-v1) and enumerates exactly what is validated: JSON schema, key/index rules, rule sets and flows with their tests. It clearly distinguishes itself from sibling checkers like check_flow and check_write_rules by scope.

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 makes the boundary explicit: this checks as far as possible without an account, and directs the agent elsewhere for plan effects (plan_schema_sync, or jsonpad sync-schema --dry-run). That is strong when-to-use routing, though it doesn't name the sibling tools it overlaps with (check_flow/check_write_rules) or say when not to call it.

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

All JSONPad documentation tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?