Skip to main content
Glama

confluence_read

Fetch a Confluence page by ID; returns GitHub-style JFM markdown or raw ADF JSON. Supports version history and file output.

Instructions

Fetch a Confluence page by numeric ID (e.g. "12345678"). Returns JFM markdown by default — AI-friendly GitHub-style markdown, the form to read/edit then feed back to confluence_write/confluence_create. That output carries localId attributes (and inline-comment anchor spans) that anchor inline comments and other stateful nodes — preserve them verbatim when editing so a later confluence_write does not drop those comments. Pass format="adf" for the raw ADF JSON (the on-the-wire document model) only when you need exact node structure. Pass version to read a specific historical version (an immutable snapshot) instead of the current head — useful for seeing what a reviewer was reading when they commented. When output_file is set, the content is written to that path and the tool returns a short YAML summary (path/bytes/format) — useful for large pages. This reads a single page; to fetch a whole page tree or an entire space to disk, use confluence_download instead. NOTE: inline-comment anchors do NOT follow text edits — to detect/repair drifted comments use confluence_comment_audit / confluence_comment_reanchor. Any author/version metadata is returned as Atlassian account IDs — resolve them to display names with confluence_user_get. Mirrors omni-dev atlassian confluence read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesConfluence page ID (e.g., "12345678").
formatNoOutput format: `"jfm"` (default, AI-friendly markdown) or `"adf"` (raw ADF JSON).
versionNoRead a specific historical version instead of the current head (e.g. `3`). Confluence stores each version as an immutable snapshot; omit for the latest. Useful for seeing what a reviewer was reading when they posted a comment.
output_fileNoWhen set, writes the rendered content to this path and returns a short YAML summary (path/bytes/format) instead of the inline body. Useful for large pages that would otherwise blow past the context window — the assistant can then read the file with offset/limit.
Behavior5/5

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

With no annotations, the description fully discloses behavior: default output is JFM markdown, `output_file` returns YAML summary, `version` reads immutable snapshots, inline-comment anchors do not follow edits, author IDs are returned as Atlassian account IDs. No contradictions.

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 thorough but slightly verbose; however, every sentence adds value and the structure is logical. It could be trimmed marginally without losing content.

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

Completeness5/5

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

Covers all 4 parameters, return formats, common pitfalls, and links to related tools. Without an output schema, the description adequately explains what the tool returns in different scenarios.

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

Parameters5/5

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

Despite 100% schema coverage, the description adds significant context: explains default format, version as immutable snapshot, output_file behavior (YAML summary, useful for large pages), and gives examples for `id`.

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 explicitly states 'Fetch a Confluence page by numeric ID' and distinguishes itself from sibling tools like `confluence_download` for page trees. It clearly identifies the resource and action.

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

Usage Guidelines5/5

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

Provides explicit guidance on when to use different formats (`jfm` vs `adf`), when to use `version`, when to use `output_file`, and when to use alternative tools (`confluence_download`, `confluence_comment_audit`, `confluence_user_get`). Also warns about preserving `localId` attributes for editing.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/rust-works/omni-dev'

If you have feedback or need assistance with the MCP directory API, please join our Discord server