About confluence-reader
confluence-reader is an MCP server published by git+satiyap in the Developer Tools category: mCP server for fetching and comparing Confluence documentation with local files.
Install
npx @satiyap/confluence-reader-mcpclaude mcp add confluence-reader-mcp -- npx -y @satiyap/confluence-reader-mcpnpx -y @satiyap/confluence-reader-mcpThis server has no ConduID identity, so agent calls to it are not receipted. Pin the version you install and review the source before granting it credentials.
Tools (4)
confluence.compareCompare a local markdown file or string with a Confluence page and show the differences.
Parameters not published.
confluence.fetch_imageDownload an image attachment from a Confluence page by filename and save it to a local directory. Returns the saved file path.
Parameters not published.
confluence.fetch_pageFetch a Confluence page as markdown. Returns the page content and lists any direct child pages so the caller can decide which children to fetch next.
Parameters not published.
confluence.list_childrenList the direct child pages of a Confluence page without fetching their content. Useful for discovering page structure before fetching individual pages.
Parameters not published.
Ask AI
Ask AI about confluence-reader
Powered by Claude · Grounded in docs
Security checks
- ✓README presentThe repository ships documentation.
- !Scoped permissionsDoesn't declare a permission scope. Assume it can do anything its process can.
4 checks have not been run yet.
README
Confluence Reader MCP Server
An MCP server that lets AI assistants read Confluence Cloud pages as markdown, browse page trees, download image attachments, and diff content against local documentation.
Features
- Fetch a single Confluence page as proper GitHub-flavored markdown (headings, tables, lists, code blocks)
- List child pages for recursive traversal
- Download image attachments by filename
- Compare local content against a Confluence page with a unified diff
- Supports scoped API tokens with Basic Auth
Setup
1. Get a Confluence API Token
Create a scoped API token from your Atlassian account: https://support.atlassian.com/confluence/kb/scoped-api-tokens-in-confluence-cloud/
2. Set Environment Variables
Add to your shell profile (~/.zshrc, ~/.bashrc, etc.):
export CONFLUENCE_TOKEN="your_scoped_token"
export CONFLUENCE_EMAIL="your_email@example.com"
export CONFLUENCE_CLOUD_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Reload your shell or open a new terminal.
| Variable | Required | Description |
|---|---|---|
CONFLUENCE_TOKEN |
Yes | Scoped API token |
CONFLUENCE_EMAIL |
Yes | Email tied to your Atlassian account |
CONFLUENCE_CLOUD_ID |
Yes* | Cloud ID — routes via api.atlassian.com |
CONFLUENCE_BASE_URL |
Yes* | Direct tenant URL, e.g. https://your-org.atlassian.net |
*One of CONFLUENCE_CLOUD_ID or CONFLUENCE_BASE_URL is required. CONFLUENCE_CLOUD_ID is recommended.
3. Add to MCP Config
{
"mcpServers": {
"confluence-reader": {
"command": "npx",
"args": ["@satiyap/confluence-reader-mcp"]
}
}
}
Restart the MCP host to pick up the new server.
Tools
confluence.fetch_page
Fetches a single Confluence page by URL and returns its content as markdown. Lists any direct child pages at the bottom so the caller can decide which to fetch next.
| Parameter | Type | Description |
|---|---|---|
url |
string | Confluence page URL |
confluence.list_children
Lists the direct child pages of a Confluence page without fetching their content. Useful for discovering page structure before fetching individual pages.
| Parameter | Type | Description |
|---|---|---|
url |
string | Confluence page URL |
confluence.fetch_image
Downloads an image attachment from a Confluence page by filename and saves it to a local directory.
| Parameter | Type | Description |
|---|---|---|
url |
string | Confluence page URL |
filename |
string | Attachment filename (e.g. architecture.png) |
destination |
string | Local directory path to save the image to |
confluence.compare
Generates a git-style unified diff between a Confluence page and a local markdown string.
| Parameter | Type | Description |
|---|---|---|
url |
string | Confluence page URL |
localContent |
string | Local markdown to compare against |
Returns a JSON object with additions, deletions, totalChanges, and the full diff.
Supported URL Formats
/wiki/spaces/SPACEKEY/pages/123456789/Page+Title/wiki/pages/viewpage.action?pageId=123456789
Security
- Credentials are read from environment variables only — never passed in config files.
- Use scoped tokens with the minimum permissions needed.
Contributing
Contributions are welcome. Please open an issue or submit a pull request.
License
MIT
README copy captured when this server was indexed; it may lag the repository. The original is authoritative.