Confluence MCP Server

1# Confluence MCP Server
2 
3A Model Context Protocol (MCP) server for interacting with Confluence Data Center via REST API. This server provides a set of tools that allow AI models to interact with Confluence content.
4 
5## Features
6 
7This MCP server provides the following operations for Confluence:
8 
9- Execute CQL (Confluence Query Language) searches
10- Get page content by ID
11- Get page content with body
12- Find pages by space key
13- Find page by title and space key
14- Create new pages (with optional parent page)
15- Update existing pages
16- Delete pages
17 
18## Installation
19 
201. Clone this repository
212. Install dependencies:
22 
23```bash
24pip install -r requirements.txt
25```
26 
27## Configuration
28 
29Create a `.env` file in the project root with the following variables:
30 
31```
32CONFLUENCE_API_BASE=http://localhost:8090/rest/api
33CONFLUENCE_USERNAME=your_username
34CONFLUENCE_PASSWORD=your_password
35```
36 
37Adjust the values to match your Confluence instance.
38 
39## Running the Server
40 
41### Development Mode (Recommended)
42 
43The proper way to run an MCP server is using the MCP CLI tool with the development mode. This will start the MCP Inspector UI which allows you to test and debug the server:
44 
45```bash
46mcp dev confluence.py
47```
48 
49This will start the MCP Inspector at http://127.0.0.1:6274 by default.
50 
51### Direct Execution (Not Recommended)
52 
53MCP servers are designed to be run with the MCP CLI tool or integrated with Claude Desktop. Direct execution with Python is not the standard way to run an MCP server, but the script includes a fallback mode for testing:
54 
55```bash
56python confluence.py
57```
58 
59However, this mode has limited functionality and is only intended for basic testing.
60 
61### Installing in Claude Desktop
62 
63To install the server in Claude Desktop:
64 
65```bash
66mcp install confluence.py
67```
68 
69## API Reference
70 
71### execute_cql_search
72 
73Execute a CQL query on Confluence to search pages.
74 
75**Parameters:**
76- `cql`: CQL query string
77- `limit`: Number of results to return (default: 10)
78 
79### get_page_content
80 
81Get the content of a Confluence page.
82 
83**Parameters:**
84- `pageId`: Confluence Page ID
85 
86### get_page_with_body
87 
88Get a page with its body content.
89 
90**Parameters:**
91- `pageId`: Confluence Page ID
92 
93### find_pages_by_space
94 
95Find pages by space key.
96 
97**Parameters:**
98- `spaceKey`: Confluence Space Key
99- `limit`: Maximum number of results to return (default: 10)
100- `expand`: Optional comma-separated list of properties to expand
101 
102### find_page_by_title
103 
104Find a page by title and space key.
105 
106**Parameters:**
107- `title`: Page title
108- `spaceKey`: Confluence Space Key
109 
110### create_page
111 
112Create a new page in Confluence.
113 
114**Parameters:**
115- `title`: Page title
116- `spaceKey`: Confluence Space Key
117- `content`: Page content in storage format (HTML)
118- `parentId`: Optional parent page ID
119 
120### update_page
121 
122Update an existing page in Confluence.
123 
124**Parameters:**
125- `pageId`: Confluence Page ID
126- `content`: New page content in storage format (HTML)
127- `title`: Optional new title for the page
128- `spaceKey`: Optional space key (only needed if changing space)
129 
130### delete_page
131 
132Delete a page by ID.
133 
134**Parameters:**
135- `pageId`: Confluence Page ID
136 
137## Example Usage
138 
139Once the server is running and connected to an AI model, you can interact with Confluence using natural language. For example:
140 
141- "Find all pages in the DOCS space"
142- "Get the content of page with ID 123456"
143- "Create a new page titled 'Meeting Notes' in the TEAM space with content '<p>Notes from our meeting</p>'"
144- "Update page with ID 123456 to have the content '<p>Updated meeting notes</p>'"
145- "Update the title of page 123456 to 'Revised Meeting Notes'"
146 
147## License
148 
149MIT
150