Skip to main content
Glama
README.md
# atlassian-mcp

An MCP (Model Context Protocol) server for exploring Atlassian resources like Confluence pages and Jira tickets.

## Setup

### 1. Install dependencies

```bash
bun install
```

### 2. Configure environment variables

Create a `.env` file or set the following environment variables:

```bash
ATLASSIAN_BASE_URL=https://your-domain.atlassian.net
ATLASSIAN_EMAIL=your-email@example.com
ATLASSIAN_API_TOKEN=your-api-token
```

To generate an API token:
1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
2. Click "Create API token"
3. Give it a name and copy the token

### 3. Build the server

```bash
bun run build
```

## Usage

### Running directly

```bash
bun run start
```

Or with bun:

```bash
bun run index.ts
```

### Adding to Cursor

Add this to your Cursor MCP settings (`~/.cursor/mcp.json`):

```json
{
  "mcpServers": {
    "atlassian": {
      "command": "bun",
      "args": ["run", "/path/to/atlassian-mcp/index.ts"],
      "env": {
        "ATLASSIAN_BASE_URL": "https://your-domain.atlassian.net",
        "ATLASSIAN_EMAIL": "your-email@example.com",
        "ATLASSIAN_API_TOKEN": "your-api-token"
      }
    }
  }
}
```

## Available Tools

### `get_confluence_page`

Retrieve a Confluence page by its ID.

**Parameters:**
- `pageId` (required): The ID of the Confluence page to retrieve
- `bodyFormat` (optional): The format for the page body. Options: `storage`, `atlas_doc_format`, `view`, `export_view`. Default: `storage`

**Example usage:**
```
Get the Confluence page with ID 12345
```

### `search_confluence`

Search for Confluence pages using CQL (Confluence Query Language).

**Parameters:**
- `query` (required): CQL query string
- `limit` (optional): Maximum number of results (default: 25)

**Example CQL queries:**
- `type=page AND space=MYSPACE` - All pages in a space
- `type=page AND text~"search term"` - Pages containing text
- `type=page AND title~"Meeting Notes"` - Pages with title containing text
- `creator=currentUser() AND created>=2024-01-01` - Pages created by you this year

## Development

### Watch mode

```bash
bun run dev
```

This will recompile TypeScript files on changes.