Atlassian Confluence MCP Server

by aashari
Verified

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
DEBUGNoEnable debug loggingfalse
ATLASSIAN_API_TOKENYesThe API token created in your Atlassian account
ATLASSIAN_SITE_NAMEYesYour Atlassian site name (e.g., for example.atlassian.net, enter example)
ATLASSIAN_USER_EMAILYesYour Atlassian account email address

Schema

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

Tools

Functions exposed to the LLM to take actions

NameDescription
list-spaces

List Confluence spaces with optional filtering capabilities.

PURPOSE: Discovers available spaces in your Confluence instance with their keys, names, types, and URLs.

WHEN TO USE:

  • When you need to discover what spaces exist in your Confluence instance
  • When you want to find spaces by type (global, personal, archived)
  • When you need to browse available spaces before accessing specific pages
  • When you need space keys for use with other Confluence tools

WHEN NOT TO USE:

  • When you already know the specific space key/ID (use get-space instead)
  • When you need detailed information about a specific space (use get-space instead)
  • When you need to find content across multiple spaces (use search instead)
  • When you need to list pages within a specific space (use list-pages instead)

RETURNS: Formatted list of spaces with IDs, keys, names, types, and URLs, plus pagination info.

EXAMPLES:

  • List all spaces: {}
  • Filter by type: {type: "global"}
  • With pagination: {limit: 10, cursor: "next-page-token"}

ERRORS:

  • Authentication failures: Check your Confluence credentials
  • No spaces found: Verify your permissions in Confluence
  • Rate limiting: Use pagination and reduce query frequency
get-space

Get detailed information about a specific Confluence space by ID or key.

PURPOSE: Retrieves comprehensive space metadata including description, homepage, permissions, and more.

WHEN TO USE:

  • When you need detailed information about a specific space
  • When you need to find the homepage or key pages within a space
  • When you need to verify space permissions or settings
  • After using list-spaces to identify the relevant space

WHEN NOT TO USE:

  • When you don't know which space to look for (use list-spaces first)
  • When you need to browse multiple spaces (use list-spaces instead)
  • When you need to find specific content (use search or list-pages instead)

RETURNS: Detailed space information including key, name, description, type, homepage, and metadata.

EXAMPLES:

  • By key: {idOrKey: "DEV"}
  • By ID: {idOrKey: "123456"}

ERRORS:

  • Space not found: Verify the space key or ID is correct
  • Permission errors: Ensure you have access to the requested space
  • Rate limiting: Cache space information when possible
list-pages

List Confluence pages with optional filtering by space and status.

PURPOSE: Finds pages within Confluence spaces with their IDs, titles, and locations to help you discover available content.

WHEN TO USE:

  • When you need to find pages within a specific space
  • When you want to list the most recently updated content
  • When you need to browse available pages before accessing specific content
  • When you need page IDs for use with other Confluence tools
  • When looking for pages with specific statuses (current, draft, trashed)

WHEN NOT TO USE:

  • When you already know the specific page ID (use get-page instead)
  • When you need the actual content of a page (use get-page instead)
  • When you need to search across multiple spaces (use search instead)
  • When you need to find spaces rather than pages (use list-spaces instead)

RETURNS: Formatted list of pages with IDs, titles, space information, and URLs, plus pagination info.

EXAMPLES:

  • Pages in a space: {spaceId: "DEV"}
  • With status filter: {spaceId: "DEV", status: "current"}
  • With pagination: {spaceId: "DEV", limit: 10, cursor: "next-page-token"}

ERRORS:

  • Space not found: Verify the space ID is correct
  • Authentication failures: Check your Confluence credentials
  • No pages found: The space might be empty or you lack permissions
  • Rate limiting: Use pagination and reduce query frequency
get-page

Get detailed information and content of a specific Confluence page by ID.

PURPOSE: Retrieves the full content of a page in Markdown format along with comprehensive metadata.

WHEN TO USE:

  • When you need to read the actual content of a page
  • When you need detailed page metadata (author, dates, versions)
  • When you need to extract specific information from a page
  • After using list-pages or search to identify relevant page IDs

WHEN NOT TO USE:

  • When you don't know which page to look for (use list-pages or search first)
  • When you only need basic page information without content (use list-pages instead)
  • When you need to find content across multiple pages (use search instead)

RETURNS: Complete page content in Markdown format with metadata including title, author, version, space, and creation/modification dates.

EXAMPLES:

  • By ID: {id: "123456"}

ERRORS:

  • Page not found: Verify the page ID is correct
  • Permission errors: Ensure you have access to the requested page
  • Rate limiting: Cache page content when possible for frequently accessed pages
search

Search for content across Confluence using Confluence Query Language (CQL).

PURPOSE: Finds content matching specific criteria with excerpts showing matches, helping you discover relevant information across spaces.

WHEN TO USE:

  • When you need to find specific content across multiple spaces
  • When you want to search by various criteria (text, title, labels, content type)
  • When you need to gather information scattered across different pages
  • When you're unfamiliar with the structure of Confluence and need discovery
  • When looking for content with specific labels or within specific date ranges

WHEN NOT TO USE:

  • When you already know the exact space and page (use get-page instead)
  • When you want to list all spaces or pages systematically (use list-spaces/list-pages)
  • When performing many rapid, consecutive searches (consider rate limits)
  • When you need to retrieve complete page content (use get-page after search)

RETURNS: Search results with titles, excerpts showing matches, content types, spaces, and URLs, plus pagination info.

EXAMPLES:

  • Simple text search: {cql: "text~documentation"}
  • Space-specific search: {cql: "space=DEV AND text~API"}
  • Title search: {cql: "title~Project Plan"}
  • Content type filter: {cql: "type=page AND label=important"}
  • With pagination: {cql: "text~API", limit: 10, cursor: "next-page-token"}

ERRORS:

  • Invalid CQL syntax: Check CQL syntax (example: "type=page AND space=DEV")
  • No results: Try broader search terms or check different spaces
  • Authentication failures: Check your Confluence credentials
  • Rate limiting: Use more specific queries and pagination