Skip to main content

Tools Reference

The Secure MCP Server exposes 7 MCP tools to connected AI clients. This page documents each one β€” what it does, its parameters, and an example prompt you can give your AI client.

Two things apply to every tool:

  • Everything runs as you. Each tool calls the Confluence REST API using your own session token (api.asUser), so it can only ever see or change content your Confluence account already has permission to β€” read and write alike.
  • Availability depends on admin settings. An admin can enable or disable whole categories of tools for the site. If a category is disabled, its tools disappear from your client's tool list and any call to them is rejected. See Admin Guide β†’ Controlling which tools are available.

The tools fall into three categories, matching the admin toggles:

CategoryToolsAdmin toggle
Readconfluence_search_pages, confluence_get_spaces, confluence_get_page, confluence_get_page_commentsRead
Page editingconfluence_create_page, confluence_update_pageCreate pages
Commentsconfluence_add_commentAdd comments

Storage Format: the page-editing and comment tools accept a body in Confluence Storage Format β€” an XHTML-based markup using tags like <p>, <h2>, and <ul><li>. AI clients generally produce this for you; you don't need to write it by hand.

Read tools​

confluence_search_pages​

Search Confluence pages and blog posts using a CQL query or plain keywords. Returns titles, spaces, and version info.

ParameterTypeRequiredDescription
querystringYesA CQL query, or plain natural-language keywords. Plain keywords match on any word (OR), so a short list of terms is safe.
limitnumberNoMaximum results to return. Default 10, maximum 50.
startnumberNoPagination offset. Default 0; increment by limit for the next page.

Example prompt: "Search Confluence for our Q3 roadmap."

confluence_get_spaces​

List the Confluence spaces you can access, narrowed by any admin space restrictions.

ParameterTypeRequiredDescription
limitnumberNoMaximum number of spaces to return. Default 25.
typestringNoFilter by space type: global or personal.
statusstringNoFilter by space status: current or archived.

Example prompt: "List the spaces I have access to."

confluence_get_page​

Get the full rendered content and metadata (title, space, version, last-modified date, labels) of a page by its ID.

ParameterTypeRequiredDescription
page_idstringYesThe ID of the Confluence page to retrieve.

Example prompt: "Show me the content of the 'Onboarding Guide' page."

confluence_get_page_comments​

Get the footer comments on a page. Each comment's text is returned with HTML stripped and truncated to 300 characters.

ParameterTypeRequiredDescription
page_idstringYesThe ID of the Confluence page.
limitnumberNoMaximum number of comments to return. Default 25.

Example prompt: "Get the comments on page 12345."

Page-editing tools​

confluence_create_page​

Create a new Confluence page. The body must be in Confluence Storage Format.

ParameterTypeRequiredDescription
space_keystringYesKey of the space to create the page in (e.g. DEV).
titlestringYesPage title.
contentstringYesPage body in Confluence Storage Format.
parent_page_idstringNoID of a parent page to nest the new page under.

Example prompt: "Draft a new page called 'Sprint 24 Notes' in the DEV space summarizing this conversation."

confluence_update_page​

Update an existing page. You must supply the page's current version number; the tool increments it for the update.

ParameterTypeRequiredDescription
page_idstringYesID of the page to update.
titlestringYesNew page title.
contentstringYesNew page body in Confluence Storage Format.
current_versionnumberYesThe page's current version number (incremented automatically).

Example prompt: "Update page 12345 to add a new section about rollback steps."

Comment tools​

confluence_add_comment​

Add a top-level footer comment to a page, posted as you. The body must be in Confluence Storage Format.

ParameterTypeRequiredDescription
page_idstringYesID of the page to comment on.
contentstringYesComment body in Confluence Storage Format.

Example prompt: "Add a comment to page 12345 summarizing the decision we reached."