Skip to main content

MCP server providing Confluence Server/Data Center integration: page management, search, spaces, and more.

Project description

www-confluence-mcp

MCP (Model Context Protocol) server providing Confluence Server/Data Center integration — page management, search, spaces, comments, labels, attachments, and more.

Gives AI assistants (Qoder, Claude Desktop, Cursor, etc.) the ability to read and write Confluence content through a single MCP server with 25 tools (24 tools + 1 prompt tool) and 2 built-in prompts.

Note: This server targets Confluence Server/Data Center only (v1 REST API). Confluence Cloud is not supported.

System Requirements

Requirement Version
uv Install guide
Python 3.10+ (managed automatically by uv)
Confluence Server 5.6+ / Data Center 6.0+

Install uv

macOS / Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows (PowerShell):

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

macOS (Homebrew):

brew install uv

Installation

Option 1: From PyPI (recommended)

uvx — one-shot run, auto-updates on every launch:

uvx www-confluence-mcp

uv tool install — persistent global command:

# Install (or update to latest):
uv tool install --force www-confluence-mcp@latest

# Run:
www-confluence-mcp

# Update later:
uv tool install --force www-confluence-mcp@latest

Option 2: From source or wheel (development)

git clone https://github.com/naifs/www-confluence-mcp.git
cd www-confluence-mcp
uv sync

# Run directly:
uv run www-confluence-mcp

# Or build and install as a global command:
uv build
uv tool install --force dist/*.whl

# Update later:
git pull && uv sync
# or rebuild:
uv build && uv tool install --force dist/*.whl

MCP Client Config

All variants share the same env block. The only difference is command and args:

{
  "mcpServers": {
    "www-confluence-mcp": {

      // Option 1a: uvx — ephemeral run from PyPI, auto-updates on each launch
      "command": "uvx",
      "args": ["www-confluence-mcp"],

      // Option 1b: uv tool install — globally installed command, no args needed
      // "command": "www-confluence-mcp",
      // "args": [],

      // Option 2: local source — run from a cloned repo (replace path)
      // "command": "uv",
      // "args": ["run", "--project", "/absolute/path/to/www-confluence-mcp", "www-confluence-mcp"],

      "env": {
        "CONFLUENCE_URL": "https://confluence.example.com",
        "CONFLUENCE_PERSONAL_TOKEN": "your-pat-here"
      }
    }
  }
}

How to use: uncomment exactly one of the command/args pairs above and delete the rest.

Authentication

The server supports two authentication methods for Confluence Server/Data Center:

Method Environment Variables
Personal Access Token (PAT) (recommended) CONFLUENCE_PERSONAL_TOKEN
Basic Auth (username + password) CONFLUENCE_USERNAME + CONFLUENCE_PASSWORD

PAT takes priority if both are configured. CONFLUENCE_API_TOKEN is accepted as a legacy fallback for CONFLUENCE_PASSWORD.

Environment Variables

Variable Description Default
CONFLUENCE_URL Confluence Server/DC base URL (required)
CONFLUENCE_PERSONAL_TOKEN Personal Access Token for PAT auth
CONFLUENCE_USERNAME Username for Basic auth
CONFLUENCE_PASSWORD Password for Basic auth
CONFLUENCE_SSL_VERIFY Verify TLS certificates (system trust store via truststore) true
CONFLUENCE_SSL_PATH Optional path to extra CA certs (PEM file or OpenSSL-hashed dir), loaded in addition to the system trust store
CONFLUENCE_TIMEOUT HTTP request timeout in seconds 30
CONFLUENCE_MAX_RESULTS Default max results per query (1..100) 25
CONFLUENCE_READ_ONLY Disable write tools (true/false) true
CONFLUENCE_SPACES_FILTER Comma-separated space keys to filter searches
CONFLUENCE_HTTP_PROXY HTTP proxy URL
CONFLUENCE_HTTPS_PROXY HTTPS proxy URL
CONFLUENCE_DEBUG Enable debug logging (1/true/yes/on) false
CONFLUENCE_PROMPTS_DIR Custom prompts directory for YAML prompts

Provided Tools

Read Tools (14)

  • confluence_search_cql — Search content by text or CQL query
  • confluence_get_page — Get page by ID or URL (saves to {workspace}/tmp/page_{page_id}.md)
  • confluence_get_page_ancestors — Get ancestor pages (breadcrumb)
  • confluence_get_spaces — List all spaces or get one by key
  • confluence_get_pages — Get pages from a space (tree) or children of a page
  • confluence_get_page_comments — Get page comments
  • confluence_get_page_labels — Get page labels
  • confluence_get_page_attachments — List page attachments
  • confluence_download_attachments — Download attachments to disk (all or by IDs, saves to {workspace}/tmp/)
  • confluence_get_page_history — Get page version history
  • confluence_get_page_images — Get page images as base64
  • confluence_get_user — Search for users by username, email, or display name
  • confluence_validate_page — Validate Confluence page with XHTML validation and round-trip checking
  • confluence_mcp_info — Get server configuration info (all environment variables, defaults, examples)
  • confluence_mcp_health — Health check (server status, uptime, version, tool count, connection status)

Write Tools (10) — only when CONFLUENCE_READ_ONLY=false

  • confluence_new_page — Create a new page
  • confluence_update_page — Update an existing page
  • confluence_delete_pages — Delete multiple pages in batch
  • confluence_move_page — Move page to another space/parent
  • confluence_add_comment — Add a comment to a page
  • confluence_add_labels — Add labels to a page
  • confluence_delete_labels — Delete multiple labels from multiple pages in batch
  • confluence_upload_attachments — Upload one or more files as attachments
  • confluence_delete_attachments — Delete multiple attachments in batch

Prompt Tool (1)

  • confluence_mcp_prompts — List all loaded external prompt definitions, or get full prompt content by name

Built-in Prompts

The server includes 2 built-in prompts accessible via confluence_mcp_prompts:

  • update_page_from_template — Merge source content with a template (supports IN-PLACE update or NEW PAGE creation)
  • how_to_write_prompts — Guide for creating YAML prompt definitions

Prompts are loaded from the builtin prompts directory and can be extended with custom prompts via CONFLUENCE_PROMPTS_DIR.

Troubleshooting

uv not found

Install uv and reopen your terminal. See System Requirements.

Dependencies missing

uv sync

MCP tools not appearing in client

  1. Check that the MCP client config JSON is valid.
  2. Ensure the --project path is absolute and correct.
  3. Reload the MCP client after config changes.
  4. Check CONFLUENCE_DEBUG=true for detailed logs.

Authentication error

  • Verify CONFLUENCE_URL points to your Server/DC instance (not *.atlassian.net).
  • For PAT: ensure the token is valid and not expired.
  • For Basic auth: ensure both CONFLUENCE_USERNAME and CONFLUENCE_API_TOKEN are set.

Wrong project path in config

The --project argument must point to the root directory of www-confluence-mcp (where pyproject.toml is located), not to the src/ subdirectory.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

www_confluence_mcp-1.1.0.tar.gz (240.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

www_confluence_mcp-1.1.0-py3-none-any.whl (125.5 kB view details)

Uploaded Python 3

File details

Details for the file www_confluence_mcp-1.1.0.tar.gz.

File metadata

  • Download URL: www_confluence_mcp-1.1.0.tar.gz
  • Upload date:
  • Size: 240.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for www_confluence_mcp-1.1.0.tar.gz
Algorithm Hash digest
SHA256 acea85b87cda49d5c3eaa6f3780ea2bfecc5b001b1d1ba23501a51b3ec73c0ee
MD5 cff153e4f5d4a8fef21034dc790895b8
BLAKE2b-256 193c50e95a8545e9f760beaf150b20bc75503d9241a9f3af4b3b3f85f77a9bc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for www_confluence_mcp-1.1.0.tar.gz:

Publisher: ci-cd.yml on Naifs/www-confluence-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file www_confluence_mcp-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for www_confluence_mcp-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7e23747dcb6cb7ef726e109f19c7243c090699dca346ca0a85a7dd5da2cf608
MD5 4c3c5525cb7f4d637f9a40caad9ccbf1
BLAKE2b-256 4c9290f3b598a39985018eccb4aaea923f9f724a28598cc64757cd77576d7b7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for www_confluence_mcp-1.1.0-py3-none-any.whl:

Publisher: ci-cd.yml on Naifs/www-confluence-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page