logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

atlassian-confluence-api-gateway

A Model Context Protocol (MCP) interface layer designed for comprehensive interaction with Atlassian Confluence Cloud services, facilitating automated administration of knowledge base assets like spaces and documentation pages, including content creation, modification, retrieval, and advanced querying.

Author

atlassian-confluence-api-gateway logo

aaronsb

No License

Quick Info

GitHub GitHub Stars 15
NPM Weekly Downloads 247
Tools 1
Last Updated 2026-02-19

Tags

confluencetoolspagesconfluence cloudinteract confluencebusiness tools

Confluence Cloud MCP Server

A Model Context Protocol (MCP) server providing advanced tooling for interfacing with Atlassian's Confluence Cloud platform. This server furnishes AI agents with a standardized mechanism to govern Confluence artifacts, encompassing space administration, page lifecycle management, and content manipulation.

CI/CD Status

Core Capabilities

  • Space Administration
  • Enumeration of existing spaces
  • Retrieval of detailed space metadata
  • Document Artifact Management
  • Generation, reading, and updating of documentation pages
  • Listing of pages within a specified space container
  • Transformation utility: Converts native Confluence storage markup to Markdown format
  • Information Retrieval & Tagging
  • Content querying utilizing Confluence Query Language (CQL)
  • Functionality for managing page associated labels (tags)

Deployment Instructions

The quickest deployment path involves utilizing the pre-compiled Docker image:

docker run --rm -i \
  -e CONFLUENCE_API_TOKEN=your-api-token \
  -e CONFLUENCE_EMAIL=your-email@domain.com \
  -e CONFLUENCE_DOMAIN=your-domain.atlassian.net \
  ghcr.io/aaronsb/confluence-cloud-mcp:latest

Path 2: Local Compilation

  1. Acquire the repository source code:
git clone https://github.com/aaronsb/confluence-cloud-mcp.git
cd confluence-cloud-mcp
  1. Execute the local build and launch scripts:
# Builds the necessary Docker artifact
./scripts/build-local.sh

# Initiates the service using local credentials
CONFLUENCE_API_TOKEN=your-token CONFLUENCE_EMAIL=your-email ./scripts/run-local.sh

Path 3: Direct Execution with npx

Execute the package immediately from its GitHub source without persistent installation:

# Providing credentials via command-line arguments
CONFLUENCE_DOMAIN=your-domain.atlassian.net \
CONFLUENCE_EMAIL=your-email@domain.com \
CONFLUENCE_API_TOKEN=your-api-token \
npx github:aaronsb/confluence-cloud-mcp

# Alternatively, referencing an environment configuration file
npx github:aaronsb/confluence-cloud-mcp --env /path/to/.env

Configure credentials in a .env file:

CONFLUENCE_DOMAIN=your-domain.atlassian.net
CONFLUENCE_EMAIL=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token

Path 4: Building from Source Code

  1. Install necessary dependencies:
npm install
  1. Set up configuration: Create a .env file containing:
CONFLUENCE_DOMAIN=your-domain.atlassian.net
CONFLUENCE_EMAIL=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token
  1. Compile the project assets:
npm run build
  1. Start the gateway service:
node build/index.js

Integration Guide

This service integrates with MCP-compliant intelligent assistants by referencing it within their configuration parameters.

Configuration Snippet for Claude Code CLI:

claude mcp add confluence-cloud npx -- github:aaronsb/confluence-cloud-mcp --env /path/to/.env

JSON Configuration for MCP Host:

{
  "mcpServers": {
    "confluence": {
      "command": "npx",
      "args": ["github:aaronsb/confluence-cloud-mcp", "--env", "/path/to/.env"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

Configuration Snippet for Containerized Operation:

{
  "mcpServers": {
    "confluence": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "ghcr.io/aaronsb/confluence-cloud-mcp:latest"],
      "env": {
        "CONFLUENCE_DOMAIN": "your-domain.atlassian.net",
        "CONFLUENCE_EMAIL": "your-email@domain.com",
        "CONFLUENCE_API_TOKEN": "your-api-token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Important Notice for Agents: AI assistants seeking deployment instructions should consult the llms-install.md documentation file for comprehensive setup guidance.

Provided Toolset Definitions

Space Management Utilities

  • list_confluence_spaces: Retrieves a catalog of all available Confluence spaces.
  • get_confluence_space: Fetches granular details pertaining to a designated space identifier.

Page Manipulation Functions

  • list_confluence_pages: Returns a roster of pages residing within a specified space.
  • get_confluence_page: Accesses a singular page entity; output content is inherently rendered as Markdown via automatic format translation.
  • create_confluence_page: Instantiates a new documentation page within a specified space.
  • update_confluence_page: Modifies the content or metadata of an existing page.

The get_confluence_page utility features built-in conversion from Confluence's internal storage representation to standard Markdown, ensuring content interoperability. Supported element conversion includes: - Heading structures (H1 through H6) - Sequential and bulleted itemizations - Hyperlinks - Text styling (bold/italics) - Source code delimiters - Data tables - Paragraph breaks and explicit line feeds

Search & Labeling Instruments

  • search_confluence_pages: Executes advanced searches against Confluence content using CQL syntax.
  • get_confluence_labels: Retrieves the collection of tags associated with a specific page.
  • add_confluence_label: Assigns a new label to a specified page.
  • remove_confluence_label: Deletes an existing label from a specified page.

Naming Convention: All exposed functions adhere strictly to the [action]_confluence_[target] nomenclature to maintain structural clarity and consistency across the integrated toolset.

Development Ecosystem

This gateway is engineered using TypeScript and conforms to established MCP SDK standards for capability implementation. The internal structure is organized as follows:

  • src/client/: Implementation layer for the Confluence API client.
  • src/handlers/: Modules responsible for processing incoming MCP tool invocation requests.
  • src/schemas/: Defines input validation structures using JSON Schema.
  • src/types/: TypeScript type definitions and interfaces.
  • src/utils/: Utility functions, notably including the content format transformation logic.

Continuous Integration/Continuous Deployment (CI/CD)

GitHub Actions orchestrates the project's lifecycle:

  • Automated validation (testing, linting) upon submission of pull requests.
  • Automatic generation and pushing of Docker images upon commits to the primary branch (main).
  • Support for building multi-architecture container images (x86_64 and ARM64).
  • Distribution of container artifacts to the GitHub Container Registry.

Local Development Workflow

Use the provided shell scripts for localized operational testing:

  • ./scripts/build-local.sh: Compiles the source and creates a local Docker artifact.
  • ./scripts/run-local.sh: Launches the locally built service instance using provided credentials.

Licensing

This software is distributed under the MIT License.

WIKIPEDIA: Business management tools are all the systems, applications, controls, calculating solutions, methodologies, etc. used by organizations to be able to cope with changing markets, ensure a competitive position in them and improve business performance.

== Overview == There are tools related to each organization's department which can be classified for each aspect of management. For example: planning tools, process tools, records tools, employee related tools, decision making tools, control tools, etc. A classification by function would consider these general aspects:

Tools used for data input and validation in any department. Tools used for controlling and improving business processes. Tools used for data consolidation and decision making. Nowadays, management tools have evolved dramatically in the last decade thanks to fast technology advances, so fast that it is difficult to select the best business tools for any situation in any company. This is caused by a never-ending fight for lower costs and increase sales, the willingness for understanding the customers' needs, and the fight for delivering the products that meet their need in the way they require. Under this scenario, managers should take a strategic attitude to business management tools instead of going for the latest tool. Usually, managers rely on the tools without any adaptation which leads to an unstable situation. Business management tools should be selected carefully, and then adapted to the organization needs and not the other way around.

== Most used == In 2013, a survey conducted by Bain & Company showed how business tools are used around the globe. These tools reflect how their outcomes contribute to each region's needs, considering the downfall and companies' market situation. The top ten includes:

Strategic planning Customer relationship management Employee engagement surveys Benchmarking Balanced scorecard Core competency Outsourcing Change management programs Supply chain management Mission statement and vision statement Market segmentation Total quality management

== Software application for businesses == Software or collection of computer programs used by business users to carry out various business operations is referred to as business software (or a business application). These business applications are used to boost output, gauge output, and carry out various other company tasks precisely. It started with management information systems and extended into enterprise resource planning systems. Then customer relationship management was added to the solution and finally the whole package moved into the cloud business management space. Although there is an actual correlation between IT efforts and the organizations' performance, two elements are key to add value to the sum; these are the implementation's effectiveness and the proper tools selections and adaptation process.

== Tools for SMEs == The tools focused on SMEs are important because they provide ways to save m

See Also

`