MCP Server Confluence Ts

🚀 MCP Confluence API Project Documentation

MCP is a tool for interacting with Confluence. It supports operations such as retrieving space information, page content, search functionality, and creating and updating pages.

🚀 Quick Start

To use MCP, you need to install Node.js and npm first. Then, install it via the following command:

npm install mcp-confluence-api --save

✨ Features

• Support for two authentication methods: Access Token and username/password.
• Ability to perform various operations on Confluence, including getting space and page information, creating and updating pages, and searching for content.

📦 Installation

npm install mcp-confluence-api --save

📚 Documentation

Configuration

MCP supports two authentication methods: Access Token and username/password. Please choose one of them according to your needs.

Example Code

const ConfluenceService = require('mcp-confluence-api');

// Authenticate with Access Token
const confluenceService = new ConfluenceService({
  url: 'https://your-instance.atlassian.com',
  accessToken: 'your_access_token'
});

// Or authenticate with username and password
const confluenceService = new ConfluenceService({
  url: 'https://your-instance.atlassian.com',
  username: 'your_username',
  password: 'your_password'
});

Usage

Basic Usage

1. Get space information

const space = await confluenceService.getSpace('SPACE_KEY');

2. Get page information

const page = await confluenceService.getPage('PAGE_ID');

3. Get a page by Pretty URL

const page = await confluenceService.getPageByPrettyUrl('SPACE_KEY', 'PAGE_TITLE');

4. Create a page

const newPage = await confluenceService.createPage({
  spaceKey: 'SPACE_KEY',
  title: 'Page Title',
  content: 'Page Content',
  parentId: 'PARENT_PAGE_ID', // Optional
  representation: 'storage' // Optional, default is 'storage'
});

5. Update a page

const updatedPage = await confluenceService.updatePage({
  id: 'PAGE_ID',
  title: 'Updated Title', // Optional
  content: 'Updated Content', // Optional
  version: 2, // Page version number
  representation: 'storage' // Optional, default is 'storage'
});

6. Search for content

const results = await confluenceService.searchContent('search query');

7. Get detailed page content

const content = await confluenceService.getPageContent('PAGE_ID');

Security Recommendations

1. It is recommended to use the Access Token authentication method for better security.
2. Rotate the Access Token regularly.
3. Do not hard - code authentication information in your code.
4. Ensure that the .env file is added to the .gitignore file.
5. Use environment variables or a secure configuration management system in a production environment.
6. If both authentication methods are configured, the system will prioritize using the Access Token.

Notes

1. You can only choose one of the Access Token and username/password authentication methods.
2. If both authentication methods are configured, the system will prioritize using the Access Token.
3. Ensure that the URL is correct and valid.
4. Keep the API version consistent with the Confluence instance version.

Error Handling

MCP provides error handling functionality. You can catch errors in the following way:

try {
  // Operation code
} catch (error) {
  console.error('Error:', error);
}

Contribution Guidelines

Community contributions are welcome! Please visit GitHub Repository to submit issues and PRs.

📄 License

The MCP Confluence API open - source project is licensed under the MIT License.