Confluence MCP server
Commit Nov 14, 2026Allows an AI client to search, read, and manage Confluence Cloud pages, spaces, comments, and attachments.
Also known as ralscha/confluence-mcp
- Stars
- 0
- Tools
- 26
- Downloads, 30 days
- —
- Latest version
- —
- Last commit
- Nov 14, 2026
- License
- MIT
What is Confluence MCP?
Confluence allows an AI client to search, read, and manage Confluence Cloud pages, spaces, comments, and attachments. It exposes 26 tools, such as confluence_get_page, confluence_search_pages, confluence_get_page_children.
Summary generated from the project's README
About Confluence MCP server
Managing documentation and knowledge bases from within an AI client is what this server enables for teams using Confluence Cloud. It allows users to search for content, read specific pages, and navigate through spaces, page hierarchies, and comment threads. By connecting to an MCP-compatible host like Claude or VS Code, developers can interact with their company wiki using natural language.
Users can choose between a readonly mode for safe exploration or a readwrite mode to actively modify documentation. In readwrite mode, the server provides tools to create new pages, update existing content using XHTML or Atlas Document Format, manage labels, and handle attachments. The server supports both stdio and streamable HTTP transports for flexible integration.
Setup requires a Confluence base URL, an account email, and an Atlassian API token provided via environment variables or CLI flags. Because the server uses Basic authentication, it is important to use a dedicated account with the minimum necessary permissions to maintain security.
Written from the project's README. Every use case is checked against a quote from it.
Confluence MCP tools 26
Detected from the READMEconfluence_get_pageconfluence_search_pagesconfluence_get_page_childrenconfluence_get_page_ancestorsconfluence_list_page_versionsconfluence_get_space_pagesconfluence_search_cqlconfluence_get_spaceconfluence_list_spacesconfluence_get_page_labelsconfluence_list_page_commentsconfluence_get_comment
Show all 26 toolsShow fewer tools
confluence_list_comment_childrenconfluence_get_page_attachmentsconfluence_get_attachmentconfluence_download_attachmentconfluence_create_pageconfluence_update_pageconfluence_delete_pageconfluence_add_page_labelconfluence_remove_page_labelconfluence_create_footer_commentconfluence_update_footer_commentconfluence_delete_footer_commentconfluence_upload_attachmentconfluence_delete_attachment
Configuration
CONFLUENCE_API_TOKENCONFLUENCE_BASE_URLCONFLUENCE_EMAILCONFLUENCE_MODE
Automated checks
Ran Nov 14, 2026Full report →Not verified yet. A server needs a score of 80, no serious finding, and enough data for us to check. How checks work · What to fix for more points
- Source repository linked and reachableralscha/confluence-mcp is public and reachablegithub.com/ralscha/confluence-mcp ↗Pass
- Package names this repository as its sourceNot checked
- Build provenance (Sigstore attestation)Not checked
- Open source license (OSI)MITspdx.org/licenses/MIT.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-11-14github.com/ralscha/confluence-mcp ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNot checked
- No critical advisory in the package or its dependenciesNot checked
- No hidden instructions to the model26 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNo tool named like delete, drop or execPass
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubconfluence-mcp
A Model Context Protocol server that exposes
Confluence Cloud tools to MCP clients (such
as Claude, VS Code, or any MCP-compatible host). Built with the official
github.com/modelcontextprotocol/go-sdk.
Supports stdio and streamable HTTP transports, and a readonly / readwrite mode switch so you can control whether write operations are exposed.
Installation
Download the latest release for your platform from the Releases page.
Quick start
# Set required environment variables
export CONFLUENCE_BASE_URL=https://your-domain.atlassian.net
export CONFLUENCE_EMAIL=you@example.com
export CONFLUENCE_API_TOKEN=your-api-token
# Run in readonly mode over stdio (safe for exploration)
go run ./cmd/confluence-mcp --mode=readonly --transport=stdio
Generate an API token at Atlassian account settings.
Configuration
All settings can be provided via environment variables or CLI flags. Flags take precedence over environment variables.
| Environment variable | CLI flag | Default | Description |
|---|---|---|---|
CONFLUENCE_BASE_URL |
--confluence-base-url |
(required) | Confluence Cloud base URL, e.g. https://your-domain.atlassian.net |
CONFLUENCE_EMAIL |
--confluence-email |
(required) | Confluence account email (used for Basic auth) |
CONFLUENCE_API_TOKEN |
--confluence-api-token |
(required) | Confluence API token |
CONFLUENCE_MODE |
--mode |
readonly |
readonly or readwrite |
MCP_TRANSPORT |
--transport |
stdio |
stdio or http |
MCP_HTTP_ADDR |
--http-addr |
127.0.0.1:8080 |
Listen address when --transport=http |
MCP_ALLOWED_ORIGINS |
--allowed-origins |
(empty) | Comma-separated browser origins allowed to call the HTTP transport |
Run confluence-mcp --version to print the build version.
Tools
Read-only tools (always available)
| Tool | Description |
|---|---|
confluence_get_page |
Get a single Confluence page by ID |
confluence_search_pages |
Search Confluence pages with filters and pagination |
confluence_get_page_children |
List direct child content of a page |
confluence_get_page_ancestors |
List a page's ancestors, from the root downwards |
confluence_list_page_versions |
List a page's version history |
confluence_get_space_pages |
List the pages in a space |
confluence_search_cql |
Search Confluence content with CQL |
confluence_get_space |
Get a single Confluence space by key or ID |
confluence_list_spaces |
List Confluence spaces with filters and pagination |
confluence_get_page_labels |
Get labels attached to a Confluence page |
confluence_list_page_comments |
List footer or inline comments on a page |
confluence_get_comment |
Get a footer or inline comment by ID |
confluence_list_comment_children |
List replies to a footer or inline comment |
confluence_get_page_attachments |
Get attachments on a Confluence page |
confluence_get_attachment |
Get attachment metadata by ID |
confluence_download_attachment |
Download a Confluence attachment's content (base64-encoded) |
Write tools (only in readwrite mode)
| Tool | Description |
|---|---|
confluence_create_page |
Create a new Confluence page |
confluence_update_page |
Update title and/or content of a page |
confluence_delete_page |
Delete a Confluence page |
confluence_add_page_label |
Add a label to a Confluence page |
confluence_remove_page_label |
Remove a label from a Confluence page |
confluence_create_footer_comment |
Create a footer comment or reply |
confluence_update_footer_comment |
Update the body of a footer comment |
confluence_delete_footer_comment |
Delete a footer comment |
confluence_upload_attachment |
Upload a file attachment to a page |
confluence_delete_attachment |
Delete a Confluence attachment |
The default mode is readonly. Set CONFLUENCE_MODE=readwrite (or
--mode=readwrite) explicitly to enable write tools.
Page and comment content uses Confluence storage format
(XHTML) by default, or Atlas Document Format (ADF). For write tools, set
body_type to plain_text to have text safely escaped and converted to storage
format, storage for XHTML, or atlas_doc_format for ADF JSON. Markdown is not a
supported write format. XHTML syntax and the ADF document root (type: "doc",
version: 1, and a content array) are validated before sending a write;
Confluence validates supported elements, macros, and ADF nodes.
Read tools return a best-effort plain text content summary. confluence_get_page
and confluence_get_comment also return the original raw_content and its
body_format, defaulting to storage. Use raw_content for editing: the plain
text summary loses tables, macros, links, and attachment references. view is
rendered HTML for reading and cannot be used as a write format.
Writing and editing articles
Enable readwrite mode, then resolve a space ID with confluence_get_space if
you only have a space key. confluence_create_page publishes immediately and
returns the new page ID and version. For example:
{
"space_id": "123",
"title": "Release guide",
"parent_id": "456",
"body_type": "storage",
"content": "<h1>Release guide</h1><p>Check the <strong>release notes</strong>.</p>"
}
For existing articles:
- Call
confluence_get_pagewithpage_idandbody_format: "storage"(or"atlas_doc_format"for ADF). - Edit
raw_content, keeping the surrounding markup and content you intend to retain. - Call
confluence_update_pagewith the complete edited body ascontent, the same format asbody_type, and the currentversionreturned by the read. The server increments the version for Confluence. Omittitleto keep it. - Read the page again to verify the saved content and version.
For example, if the read returned version 3:
{
"page_id": "789",
"version": 3,
"version_note": "Clarify release steps",
"body_type": "storage",
"content": "<h1>Release guide</h1><p>Review the release notes before publishing.</p>"
}
Content updates replace the entire body. An explicit empty content string
clears the body; omitting it leaves the body unchanged. A title-only rename
uses the dedicated title endpoint and accepts just page_id and title.
To use version or version_note when renaming, also supply the unchanged
raw_content and its format in a versioned content update.
On a version conflict, retrieve the latest page, merge your changes, and submit that version. The server does not retry writes automatically. If a request times out or returns an unusable response, inspect Confluence before retrying: the write may already have succeeded.
For plain text, body_type: "plain_text" escapes special characters and converts
blank lines to paragraphs, including Windows CRLF line endings. For rich storage
content, use Confluence XHTML, including ac: macros, ri: attachment references,
and CDATA for code macro bodies. See the storage format reference
and page API.
Transports
stdio
The default transport. The server communicates over stdin/stdout using newline-delimited JSON (the standard MCP transport for subprocess-based tools).
confluence-mcp --transport=stdio
HTTP (streamable)
The server exposes a streamable HTTP endpoint on the configured address.
confluence-mcp --transport=http --http-addr=127.0.0.1:8080
The HTTP transport has no built-in authentication. It binds to loopback by
default, and browser requests are rejected unless the Origin header is a
loopback origin or is listed in MCP_ALLOWED_ORIGINS, which guards against DNS
rebinding attacks. Requests without an Origin header (ordinary non-browser MCP
clients) are unaffected.
If you bind to a non-loopback address, secure it at the network or deployment
layer (authenticating reverse proxy, firewall) to prevent unauthorized access,
especially in readwrite mode.
confluence-mcp --transport=http --allowed-origins=https://mcp.example.com
Limits
- Tool
limitparameters default to 25 and are clamped to Confluence's maximum of 250. - Page-version requests that include
body_formatare clamped to Confluence's lower maximum of 50. - CQL searches expanding
body.export_vieworbody.styled_vieware clamped to Confluence's maximum of 25. - API responses are capped at 4 MiB.
- Attachment downloads larger than 8 MiB are rejected rather than base64-encoded into a tool result.
Authentication
The server authenticates to Confluence Cloud using HTTP Basic auth with your Confluence account email as the username and an API token as the password.
Required token permissions
Atlassian API tokens do not grant more access than the Atlassian account has. Use a dedicated account with the smallest Confluence space permissions needed for the tools you expose.
You can use either:
- A classic/unscoped API token with
CONFLUENCE_BASE_URLset to your site URL, e.g.https://your-domain.atlassian.net. - A scoped API token. Scoped tokens must call the Atlassian API gateway, e.g.
CONFLUENCE_BASE_URL=https://api.atlassian.com/ex/confluence/{cloudId}.
For scoped tokens, grant these Confluence scopes:
| Mode | Token scopes | Confluence permissions the account still needs |
|---|---|---|
readonly |
read:page:confluence, read:space:confluence, read:attachment:confluence, read:comment:confluence, read:content-details:confluence, read:content.metadata:confluence, read:hierarchical-content:confluence |
Confluence product access (Can use) and view permission for the spaces/pages/comments/attachments to read. Page restrictions still apply. |
readwrite |
All readonly scopes, plus write:page:confluence, read:label:confluence, write:label:confluence, write:attachment:confluence, write:comment:confluence, delete:page:confluence, delete:attachment:confluence, delete:comment:confluence |
The readonly permissions, plus only the space permissions required by the write tools you use: add/update/delete pages, add/remove labels, add attachments, add/update/delete comments, and/or delete attachments. |
confluence-mcp does not need Confluence admin scopes or space-management
scopes because it does not create spaces or change space settings.
Development
Requirements
- Go 1.27.1+
Build
go build ./...
Test
go test ./...
Tests cover:
- Config loading, validation, and flag/env precedence
- Confluence REST API client against
httptest.Servermocks for pages, spaces, labels, comments, CQL search, and attachments (success, error mapping, response size limits, multipart attachment uploads) - Tool handler input mapping, limit clamping, and result summarization
- Mode-gated tool registration (
readonlyexcludes write tools) - HTTP transport origin validation
- Article lifecycle tests through the official SDK client over stdio (a server subprocess) and streamable HTTP: creation, exact rich-body readback, updates, renames, version notes, label addition, conflicts, and explicit body clearing
Tests use local Confluence API fixtures; they do not publish to a live tenant. The live service may normalize markup or apply tenant-specific macro and editor rules, so use the readback step to verify published articles.
MCP client configuration
Claude Desktop (stdio)
{
"mcpServers": {
"confluence": {
"command": "confluence-mcp",
"args": [],
"env": {
"CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net",
"CONFLUENCE_EMAIL": "you@example.com",
"CONFLUENCE_API_TOKEN": "your-api-token",
"CONFLUENCE_MODE": "readonly"
}
}
}
}
VS Code / GitHub Copilot (stdio)
Add to .vscode/mcp.json (or your user-level mcp.json):
{
"servers": {
"confluence": {
"command": "confluence-mcp",
"args": [],
"env": {
"CONFLUENCE_BASE_URL": "https://your-domain.atlassian.net",
"CONFLUENCE_EMAIL": "you@example.com",
"CONFLUENCE_API_TOKEN": "your-api-token",
"CONFLUENCE_MODE": "readonly"
}
}
}
}
API Coverage
This server primarily uses the Confluence Cloud REST API v2. CQL search, attachment upload/download, and label addition/removal use Confluence REST API v1 endpoints because those operations are not exposed by v2. The server covers a core subset focused on pages, spaces, labels, comments, attachments, page history, and CQL search.
Not currently supported:
- Blog posts
- Content properties
- Space permissions
- User management
License
MIT
Related Projects
- jira-mcp - MCP server for Jira Cloud
- Model Context Protocol
- MCP Go SDK
Confluence MCP questions
What tools does Confluence MCP provide?
It exposes 26 tools, including confluence_get_page, confluence_search_pages, confluence_get_page_children, confluence_get_page_ancestors, confluence_list_page_versions.
Can I use Markdown to write pages?
No, Markdown is not a supported write format; you must use Confluence storage format (XHTML), Atlas Document Format (ADF), or plain text.
What are the available transport methods?
The server supports stdio (the default) and streamable HTTP transports.