CONFLUENCE MCP Tools

Total Tools: 24

Quick Reference

# List all confluence tools
dmtools list | jq '.tools[] | select(.name | startswith("confluence_"))'

# Example usage
dmtools confluence_contents_by_urls [arguments]

Usage in JavaScript Agents

// Direct function calls for confluence tools
const result = confluence_contents_by_urls(...);
const result = confluence_search_content_by_text(...);
const result = confluence_content_by_id(...);

Available Tools

Detailed Parameter Information

confluence_content_by_id

Get Confluence content by its unique content ID. Returns detailed content information including body, version, and metadata. Use format=md to convert body.storage.value to Markdown.

Parameters:

• contentId (string) Required

  • The unique content ID of the Confluence page
  • Example: 123456

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_content_by_id "value" "value"

// In JavaScript agent
const result = confluence_content_by_id("contentId", "format");

confluence_content_by_title

Get Confluence content by title in the default space. Returns content result with metadata and body information. Use format=md to convert body.storage.value to Markdown.

Parameters:

• title (string) Required

  • Title of the Confluence page to get
  • Example: Project Documentation

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_content_by_title "value" "value"

// In JavaScript agent
const result = confluence_content_by_title("title", "format");

confluence_content_by_title_and_space

Get Confluence content by title and space key. Returns content result with metadata and body information. Use format=md to convert body.storage.value to Markdown.

Parameters:

• title (string) Required

  • The title of the Confluence page
  • Example: Project Documentation

• space (string) Required

  • The space key where the content is located
  • Example: PROJ

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_content_by_title_and_space "value" "value"

// In JavaScript agent
const result = confluence_content_by_title_and_space("title", "space");

confluence_contents_by_urls

Get Confluence content by multiple URLs. Returns a list of content objects for each valid URL. Use format=md to convert body.storage.value to Markdown.

Parameters:

• urlStrings (array) Required

  • Array of Confluence URLs to retrieve content from
  • Example: ['https://confluence.example.com/wiki/spaces/SPACE/pages/123/Page+Title']

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_contents_by_urls "value" "value"

// In JavaScript agent
const result = confluence_contents_by_urls("urlStrings", "format");

confluence_create_page

Create a new Confluence page with specified title, parent, body content, and space. Returns the created content object.

Parameters:

• title (string) Required

  • The title of the new page
  • Example: New Project Page

• parentId (string) Required

  • The ID of the parent page
  • Example: 123456

• body (string) Required

  • The body content of the page in Confluence storage format
  • Example: <p>This is the page content.</p>

• space (string) Required

  • The space key where to create the page
  • Example: PROJ

Example:

dmtools confluence_create_page "value" "value"

// In JavaScript agent
const result = confluence_create_page("title", "parentId");

confluence_download_attachment

Download an attachment file from Confluence to a specified directory.

Parameters:

• attachment (object) Required

  • The attachment object to download

• targetDir (object) Required

  • The target directory to save the file
  • Example: /path/to/directory

Example:

dmtools confluence_download_attachment "value" "value"

// In JavaScript agent
const result = confluence_download_attachment("attachment", "targetDir");

confluence_download_pages

Download Confluence pages and their attachments to a local folder. Recursively follows linked pages, children macros, and internal ac:link references up to the specified depth.

Parameters:

• urlStrings (array) Required

  • Array of Confluence page URLs to download
  • Example: ['https://wiki.example.com/wiki/spaces/SPACE/pages/123/Page']

• outputPath (string) Required

  • Local folder path where pages and attachments will be saved
  • Example: /tmp/confluence-pages

• depth (number) Optional

  • How many levels of linked/child pages to follow. Default is 1.
  • Example: 1

• downloadAttachments (boolean) Optional

  • Whether to download page attachments. Default is true.
  • Example: true

Example:

dmtools confluence_download_pages "value" "value"

// In JavaScript agent
const result = confluence_download_pages("urlStrings", "outputPath");

confluence_find_content

Find a Confluence page by title in the default space. Returns the page content if found. Use format=md to convert body.storage.value to Markdown.

Parameters:

• title (string) Required

  • Title of the Confluence page to find
  • Example: Project Documentation

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_find_content "value" "value"

// In JavaScript agent
const result = confluence_find_content("title", "format");

confluence_find_content_by_title_and_space

Find Confluence content by title and space key. Returns the first matching content or null if not found. Use format=md to convert body.storage.value to Markdown.

Parameters:

• title (string) Required

  • The title of the content to find
  • Example: Project Documentation

• space (string) Required

  • The space key where to search for the content
  • Example: PROJ

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_find_content_by_title_and_space "value" "value"

// In JavaScript agent
const result = confluence_find_content_by_title_and_space("title", "space");

confluence_find_or_create

Find a Confluence page by title in the default space, or create it if it doesn’t exist. Returns the found or created content.

Parameters:

• title (string) Required

  • Title of the page to find or create
  • Example: Project Documentation

• parentId (string) Required

  • ID of the parent page for creation
  • Example: 123456

• body (string) Required

  • Body content for the new page (if creation is needed)
  • Example: <p>This is the page content.</p>

Example:

dmtools confluence_find_or_create "value" "value"

// In JavaScript agent
const result = confluence_find_or_create("title", "parentId");

confluence_get_children_by_id

Get child pages of a Confluence page by content ID. Returns a list of child content objects. Use format=md to convert body.storage.value to Markdown.

Parameters:

• contentId (string) Required

  • The content ID of the parent page
  • Example: 123456

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_get_children_by_id "value" "value"

// In JavaScript agent
const result = confluence_get_children_by_id("contentId", "format");

confluence_get_children_by_name

Get child pages of a Confluence page by space key and content name. Returns a list of child content objects. Use format=md to convert body.storage.value to Markdown.

Parameters:

• spaceKey (string) Required

  • The space key where the parent page is located
  • Example: PROJ

• contentName (string) Required

  • The name/title of the parent page
  • Example: Project Documentation

• format (string) Optional

  • Output format for the page body. Use ‘md’ or ‘markdown’ to convert Confluence storage format to Markdown.
  • Example: md

Example:

dmtools confluence_get_children_by_name "value" "value"

// In JavaScript agent
const result = confluence_get_children_by_name("spaceKey", "contentName");

confluence_get_content_attachments

Get all attachments for a specific Confluence content. Returns a list of attachment objects with metadata.

Parameters:

• contentId (string) Required
  • The content ID to get attachments for
  • Example: 123456

Example:

dmtools confluence_get_content_attachments "value"

// In JavaScript agent
const result = confluence_get_content_attachments("contentId");

confluence_get_current_user_profile

Get the current user’s profile information from Confluence. Returns user details for the authenticated user.

Parameters: None

Example:

dmtools confluence_get_current_user_profile

// In JavaScript agent
const result = confluence_get_current_user_profile();

confluence_get_page_inline_comments

Get inline comments (annotations) for a Confluence page. Uses the Confluence REST API v2 and returns comment bodies in storage format.

Parameters:

• pageId (string) Required

  • The content ID of the Confluence page
  • Example: 123456

• limit (number) Optional

  • Maximum number of inline comments to return. Defaults to 25 if not provided.
  • Example: 25

Example:

dmtools confluence_get_page_inline_comments "value" "value"

// In JavaScript agent
const result = confluence_get_page_inline_comments("pageId", "limit");

confluence_get_user_profile_by_id

Get a specific user’s profile information from Confluence by user ID. Returns user details for the specified user.

Parameters:

• userId (string) Required
  • The account ID of the user to get profile for
  • Example: 123456:abcdef-1234-5678-90ab-cdef12345678

Example:

dmtools confluence_get_user_profile_by_id "value"

// In JavaScript agent
const result = confluence_get_user_profile_by_id("userId");

confluence_reply_to_inline_comment

Reply to an existing inline comment (annotation) on a Confluence page. The reply body is treated as plain text and converted to Confluence storage format.

Parameters:

• pageId (string) Required

  • The content ID of the Confluence page where the inline comment is located
  • Example: 123456

• commentId (string) Required

  • The ID of the inline comment (annotation) to reply to
  • Example: 789012

• body (string) Required

  • The reply text in plain text. Line breaks are converted to paragraphs.
  • Example: Thanks for the note, I will check it.

Example:

dmtools confluence_reply_to_inline_comment "value" "value"

// In JavaScript agent
const result = confluence_reply_to_inline_comment("pageId", "commentId");

confluence_search_content_by_text

Search Confluence content by text query using CQL (Confluence Query Language). Returns search results with content excerpts. Default limit is 20 if not specified.

Parameters:

• query (string) Required

  • Search query text to find in Confluence content
  • Example: project documentation

• limit (number) Optional

  • Maximum number of search results to return. Default is 20 if not provided.
  • Example: 10

Example:

dmtools confluence_search_content_by_text "value" "value"

// In JavaScript agent
const result = confluence_search_content_by_text("query", "limit");

confluence_sync_markdown_directory

Synchronize a local Markdown directory tree to a Confluence page subtree. Markdown files become child pages, images and other files become attachments. Links between Markdown files are rewritten to Confluence page links. Returns a JSON summary.

Parameters:

• directory (string) Required

  • The local directory containing Markdown files and attachments
  • Example: /path/to/docs

• parentId (string) Required

  • The content ID of the parent Confluence page
  • Example: 123456

• space (string) Required

  • The space key where the pages should be created
  • Example: PROJ

• deleteOrphans (boolean) Optional

  • Whether to delete child pages not present in the directory tree
  • Example: false

• attachmentsDir (string) Optional

  • Optional directory containing referenced attachments. Defaults to the Markdown file’s directory.
  • Example: /path/to/attachments

• preserveInlineComments (boolean) Optional

  • Whether to carry inline comment anchors over from the existing page bodies (default: true). When enabled, ac:inline-comment-marker elements are re-applied after the body is replaced, and [[ic:REF]]…[[/ic]] placeholders in the Markdown are converted into real markers.
  • Example: true

Example:

dmtools confluence_sync_markdown_directory "value" "value"

// In JavaScript agent
const result = confluence_sync_markdown_directory("directory", "parentId");

confluence_test

Test Confluence connectivity by fetching the current user’s profile

Parameters: None

Example:

dmtools confluence_test

// In JavaScript agent
const result = confluence_test();

confluence_update_page

Update an existing Confluence page with new title, parent, body content, and space. Returns the updated content object.

Parameters:

• contentId (string) Required

  • The ID of the page to update
  • Example: 123456

• title (string) Required

  • The new title for the page
  • Example: Updated Project Page

• parentId (string) Required

  • The ID of the new parent page
  • Example: 123456

• body (string) Required

  • The new body content of the page in Confluence storage format
  • Example: <p>This is the updated page content.</p>

• space (string) Required

  • The space key where the page is located
  • Example: PROJ

Example:

dmtools confluence_update_page "value" "value"

// In JavaScript agent
const result = confluence_update_page("contentId", "title");

confluence_update_page_with_history

Update an existing Confluence page with new content and add a history comment. Returns the updated content object.

Parameters:

• contentId (string) Required

  • The ID of the page to update
  • Example: 123456

• title (string) Required

  • The new title for the page
  • Example: Updated Project Page

• parentId (string) Required

  • The ID of the new parent page
  • Example: 123456

• body (string) Required

  • The new body content of the page in Confluence storage format
  • Example: <p>This is the updated page content.</p>

• space (string) Required

  • The space key where the page is located
  • Example: PROJ

• historyComment (string) Required

  • Comment to add to the page history
  • Example: Updated content based on user feedback

Example:

dmtools confluence_update_page_with_history "value" "value"

// In JavaScript agent
const result = confluence_update_page_with_history("contentId", "title");

confluence_upload_attachment

Upload a single file as an attachment to a Confluence page. Skips existing attachments by default. Returns the attachment object.

Parameters:

• contentId (string) Required

  • The content ID of the page to attach the file to
  • Example: 123456

• file (object) Required

  • The local file to upload
  • Example: /path/to/image.png

• updateIfExists (boolean) Optional

  • Whether to overwrite an existing attachment with the same name
  • Example: false

Example:

dmtools confluence_upload_attachment "value" "value"

// In JavaScript agent
const result = confluence_upload_attachment("contentId", "file");

confluence_upload_attachments

Upload all files in a directory as attachments to a Confluence page. Existing attachments are skipped by default. Returns a JSON summary.

Parameters:

• contentId (string) Required

  • The content ID of the page to attach files to
  • Example: 123456

• directory (string) Required

  • The local directory containing files to upload
  • Example: /path/to/attachments

• updateIfExists (boolean) Optional

  • Whether to overwrite existing attachments with the same names
  • Example: false

Example:

dmtools confluence_upload_attachments "value" "value"

// In JavaScript agent
const result = confluence_upload_attachments("contentId", "directory");