MCP server for The Confluence Cloud REST API
Project description
The Confluence Cloud REST API MCP Server
Base URL: //your-domain.atlassian.net
API Info
- Terms of Service: https://atlassian.com/terms/
Install
Quick Start (recommended)
OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
OAUTH2_SCOPES=YOUR_OAUTH2_SCOPES \
BASIC_AUTH_USERNAME=YOUR_BASIC_AUTH_USERNAME \
BASIC_AUTH_PASSWORD=YOUR_BASIC_AUTH_PASSWORD \
uvx mcparmory-atlassian-confluence
With pip
pip install mcparmory-atlassian-confluence
OAUTH2_CLIENT_ID=YOUR_OAUTH2_CLIENT_ID \
OAUTH2_CLIENT_SECRET=YOUR_OAUTH2_CLIENT_SECRET \
OAUTH2_SCOPES=YOUR_OAUTH2_SCOPES \
BASIC_AUTH_USERNAME=YOUR_BASIC_AUTH_USERNAME \
BASIC_AUTH_PASSWORD=YOUR_BASIC_AUTH_PASSWORD \
mcparmory-atlassian-confluence
MCP Client Configuration
Add to your MCP client config (e.g. Claude Desktop, Cursor, Codex):
{
"mcpServers": {
"atlassian-confluence": {
"command": "uvx",
"args": ["mcparmory-atlassian-confluence"],
"env": {
"OAUTH2_CLIENT_ID": "YOUR_OAUTH2_CLIENT_ID",
"OAUTH2_CLIENT_SECRET": "YOUR_OAUTH2_CLIENT_SECRET",
"OAUTH2_SCOPES": "YOUR_OAUTH2_SCOPES",
"BASIC_AUTH_USERNAME": "YOUR_BASIC_AUTH_USERNAME",
"BASIC_AUTH_PASSWORD": "YOUR_BASIC_AUTH_PASSWORD"
}
}
}
}
Set OAUTH2_SCOPES to a comma-separated list of scopes your app requires (e.g. OAUTH2_SCOPES=scope_a,scope_b). Open .env to see all available scopes with descriptions.
Credentials
Set the following environment variables (via MCP client env config, shell export, or .env file):
OAUTH2_CLIENT_ID— OAuth2 client IDOAUTH2_CLIENT_SECRET— OAuth2 client secretOAUTH2_SCOPES— OAuth2 scopes (comma-separated)BASIC_AUTH_USERNAME— UsernameBASIC_AUTH_PASSWORD— Password Do not commit credentials to version control.
OAuth2
Add this redirect URI to your OAuth provider's allowed redirect URIs:
http://localhost:9400/callback
If you change OAUTH2_CALLBACK_PORT in .env, update the redirect URI to match.
On first use, a browser window opens automatically for OAuth authorization. Grant access when prompted — tokens are saved to tokens/oauth2_tokens.json and refreshed automatically.
Re-authorization: Delete tokens/oauth2_tokens.json and restart the server.
Run Locally
First, configure your credentials in .env (see Credentials above).
pip install -r requirements.txt
python server.py
Connect MCP Client
Edit .mcp.json and replace <SERVER_DIR> with the absolute path to this directory, then add to your MCP client configuration.
Example (if server is at /home/user/mcp-servers/atlassian-confluence):
{
"mcpServers": {
"atlassian-confluence": {
"command": "python",
"args": ["/home/user/mcp-servers/atlassian-confluence/server.py"]
}
}
}
Docker
First, configure your credentials in .env (see Credentials above).
docker build -t atlassian-confluence .
mkdir -p tokens
docker run -p 8000:8000 -p 9400:9400 -v ./tokens:/app/tokens --env-file .env atlassian-confluence
Before running, make sure ports 8000, 9400 are free. If you changed the callback port in .env, update the -p port mapping and your OAuth provider's redirect URI to match.
On first run, the server prints an authorization URL — check docker logs for the URL. Open it in your browser to complete OAuth consent. Tokens are persisted to ./tokens/ via the volume mount so re-authorization is not needed on subsequent runs.
For Docker, use SSE transport in your MCP client config:
{
"mcpServers": {
"atlassian-confluence": {
"type": "sse",
"url": "http://localhost:8000/sse"
}
}
}
Files
.env- Credentials and server configuration.mcp.json- MCP client config templateDockerfile- Container buildLICENSE- MIT license for this generated coderequirements.txt- Python dependenciesREADME.md- This fileserver.py- MCP server entry point_auth.py- Authentication handlers_models.py- Request/response models_validators.py- Input validation
Note: Files starting with . are hidden by default on macOS/Linux. Use ls -a in terminal or enable "Show hidden files" in your file manager to see .env and .mcp.json.
Generated by MCP Blacksmith · Quickstart docs · Report a bug
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcparmory_atlassian_confluence-1.0.0-py3-none-any.whl.
File metadata
- Download URL: mcparmory_atlassian_confluence-1.0.0-py3-none-any.whl
- Upload date:
- Size: 104.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2bc39fa956bc3447b0ec8eaa239669a900ba8772f9ee4bfc8015b9b25428b2d1
|
|
| MD5 |
c39ea41e93566141932f8e02414efb68
|
|
| BLAKE2b-256 |
fbcab6a0a453f4922290d2474b2568191b18f417ff8d243ce65a4db1973658e4
|