Skip to main content
Glama

confluence_get_space_overview

Retrieve Confluence space metadata and its homepage content tree in a single call. Use this to explore a space's structure without multiple API requests.

Instructions

HIGH-LEVEL: Get space metadata and the homepage/root content tree in one MCP call. Prefer this when first learning a space instead of listing spaces, fetching the space, and recursively listing children. Provide either space_id or space_key; with space_key (for example DOCS) the server resolves the numeric space id itself. status.nextCursor can be passed back as cursor to continue the tree traversal. The tree is always budgeted and reports partial/truncated state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
depthNo
cursorNo
root_idNo
space_idNo
max_charsNo
max_itemsNo
root_typeNopage
space_keyNo
output_modeNocompact
include_version_historyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses the combined-call behavior, server-side space_key resolution, cursor-based continuation, and the fact that the tree is always budgeted and reports partial/truncated state. It stops short of defining the exact budget limits or return shape, but the key behavioral traits are transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a compact, high-signal paragraph: purpose first, usage rule, key parameters, pagination, and budget behavior. Every sentence adds information and none duplicates structured schema data.

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

Completeness3/5

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

For a 10-parameter tool with no annotations and no output schema, this description covers the core use case well but omits semantics for several important fields (especially root_type, output_mode, and include_version_history) and does not describe the returned metadata structure. It is adequate for the happy-path first-learning scenario but not fully complete for advanced usage.

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% and only space_id/space_key and cursor semantics are explained in prose. depth, root_id, root_type, output_mode, max_chars, max_items, and include_version_history receive no meaning beyond their type/enum/default in the schema, leaving a substantial semantic gap.

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 action and resource — 'Get space metadata and the homepage/root content tree in one MCP call' — and explicitly contrasts it with the multi-call alternative of listing spaces, fetching a space, and recursively listing children. This clearly distinguishes it from sibling tools like confluence_get_space and confluence_list_children.

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?

It gives an explicit usage rule: 'Prefer this when first learning a space' and tells the agent what multi-step pattern to avoid. It also explains the space_id vs space_key input convention and the cursor continuation pattern, so an agent knows both when and how to invoke it.

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