adf-format-json-schema
Query Atlassian Document Format (ADF) JSON schema definitions to understand ADF node and mark types. Use this skill when implementing ADF dataclass nodes/marks, or when user asks about ADF structure, ADF nodes, ADF marks, or Atlassian Document Format implementation.
When & Why to Use This Skill
The ADF JSON Schema Query skill streamlines the development of Atlassian-compatible applications by providing instant access to Atlassian Document Format (ADF) definitions. It allows developers to query node and mark types used in Jira and Confluence, ensuring that data structures are implemented with correct properties, required fields, and schema compliance.
Use Cases
- Case 1: Implementing Python dataclasses for ADF nodes and marks by retrieving precise property definitions and validation rules.
- Case 2: Debugging document rendering issues in Jira or Confluence by verifying the expected JSON structure of specific ADF elements.
- Case 3: Exploring the ADF schema to identify available formatting options, such as supported mark types (e.g., strong, link) for specific text nodes.
- Case 4: Accelerating the development of document conversion tools that transform external content into valid Atlassian Document Format.
| name | adf-format-json-schema |
|---|---|
| description | Query Atlassian Document Format (ADF) JSON schema definitions to understand ADF node and mark types. Use this skill when implementing ADF dataclass nodes/marks, or when user asks about ADF structure, ADF nodes, ADF marks, or Atlassian Document Format implementation. |
ADF JSON Schema Query Skill
This skill provides tools to query the Atlassian Document Format (ADF) JSON schema, which defines the structure of all node and mark types used in Confluence pages and Jira issue fields.
Purpose
When implementing ADF nodes or marks as Python dataclasses, you need to understand:
- What properties each type has
- Which properties are required vs optional
- The allowed values for each property
This skill helps you query the schema to get this information.
Commands
List All Definitions
Lists all available node and mark definitions in the ADF schema:
.venv/bin/python ./.claude/skills/adf-format-json-schema/scripts/adf_schema_cli.py list_def
Output format: name = <definition_name>, properties = [<property_list>]
Definitions follow naming conventions:
*_node- Node types (e.g.,paragraph_node,heading_node)*_mark- Mark types (e.g.,strong_mark,em_mark,link_mark)
Get Definition Details
Gets the full JSON schema for a specific definition:
.venv/bin/python ./.claude/skills/adf-format-json-schema/scripts/adf_schema_cli.py get_def <definition_name>
Example:
.venv/bin/python ./.claude/skills/adf-format-json-schema/scripts/adf_schema_cli.py get_def strong_mark
Workflow
When implementing an ADF node or mark:
- List definitions to find the exact definition name
- Get definition details to understand the schema structure
- Implement the dataclass based on the schema properties and requirements