Skip to main content
Glama

confluence_download

Recursively download Confluence pages or an entire space to a local directory, with optional attachment inclusion.

Instructions

Recursively download a Confluence page or an entire space into a directory. Either id (root page) or space (space key) must be provided. Set include_attachments: true to also fetch each page's attachment binaries into an attachments/ subdirectory beside its content file. Returns a YAML manifest summary of downloaded pages. To read a single page's body instead (no files written), use confluence_read. Mirrors omni-dev atlassian confluence download.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoRoot page ID to download from. Either this or `space` must be set.
spaceNoSpace key to download from — every top-level page becomes a root.
formatNoOutput format: `"jfm"` (default) or `"adf"`.
max_depthNoMaximum tree depth. 0 = unlimited (default).
output_dirNoTarget directory for downloaded files. Defaults to a fresh tempdir when omitted; the manifest summary reports the path used.
concurrencyNoMaximum number of concurrent fetches. Defaults to 8.
title_filterNoOnly download pages whose title contains this substring (case-insensitive).
include_attachmentsNoAlso download each page's attachment binaries into an `attachments/` subdirectory beside its content file. Defaults to false.
Behavior3/5

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

Discloses the core behavior (recursive download, YAML manifest, attachment handling) but lacks deeper context such as side effects (filesystem writes), error handling, or rate limits. Since no annotations are provided, the description carries full burden, and it covers only the basic behavioral traits.

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 concise paragraph of five sentences, each adding new information. It is front-loaded with the primary purpose and efficiently conveys key usage details without redundancy.

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?

Given the tool's complexity (8 parameters, no output schema, no annotations), the description adequately covers the main use case, alternative tool, and key parameters. It mentions the return format (YAML manifest) and attachment subdirectory, providing sufficient context for an agent to invoke the tool correctly.

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 100%, so the schema already documents all parameters. The description adds value by clarifying the id/space mutual exclusivity and the `include_attachments` behavior, but does not significantly extend parameter understanding beyond the schema.

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 clearly states 'Recursively download a Confluence page or an entire space into a directory' using specific verbs and distinct resources. It differentiates from the sibling tool `confluence_read` by noting that tool reads a single page's body without file writes.

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?

Explicitly states the alternative `confluence_read` for single-page reading, and outlines key usage requirements like providing either `id` or `space`. However, it does not explicitly mention when not to use this tool beyond the alternative.

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