Documentation
Complete reference for configuring and running Foxbridge.
Overview
Foxbridge is a self-hosted AI assistant for Atlassian Data Center. It connects to Jira, Confluence, and Bitbucket through a web chat interface and an MCP endpoint for IDE integration. You choose the AI provider, and all data stays on your infrastructure.
Foxbridge runs as a Docker container exposing two ports:
- Port 3000 — Web chat UI (browser-based interface)
- Port 3001 — MCP transport (for Claude Code, VS Code, Cursor, and other MCP clients)
Complete Config Reference
Foxbridge is configured via a foxbridge.yaml file mounted into the Docker container. Here is every available option with defaults:
license_key: "FK-XXXXXXXX-XXXXXXXX-XXXXXXXX"
atlassian:
platform: "datacenter"
base_url: "https://jira.yourcompany.com"
auth_method: "pat" # "basic" or "pat"
jira_url: "" # optional: override for Jira
confluence_url: "" # optional: override for Confluence
bitbucket_url: "" # optional: override for Bitbucket
ai:
provider: "anthropic" # "anthropic", "openai", "azure_openai", or "ollama"
api_key: "sk-ant-..." # API key (not needed for Ollama)
model: "" # optional: override default model
base_url: "" # required for azure_openai and ollama
features:
jira:
read: true
write: false
confluence:
read: true
write: false
bitbucket:
read: true
write: false
scrub_pii: false # redact PII before sending to AI
dev_mode: false # bypass license check (development only)
log_level: "info" # "debug", "info", "warn", or "error"
port_chat: 3000 # web chat UI port
port_mcp: 3001 # MCP transport port All options explained
| Option | Type | Default | Description |
|---|---|---|---|
| license_key | string | — | Your Foxbridge license key. Required to start. |
| atlassian | |||
| atlassian.platform | "datacenter" | — | Atlassian Data Center. |
| atlassian.base_url | URL | — | Root URL of your Data Center instance (e.g., https://jira.company.com). |
| atlassian.auth_method | "basic" | "pat" | "pat" | "basic" = username + password. "pat" = Personal Access Token. PAT is recommended. |
| atlassian.jira_url | URL | base_url | Override if Jira is on a different URL than base_url. Data Center only. |
| atlassian.confluence_url | URL | base_url | Override if Confluence is on a different URL. Data Center only. |
| atlassian.bitbucket_url | URL | base_url | Override if Bitbucket is on a different URL. Data Center only. |
| ai | |||
| ai.provider | "anthropic" | "openai" | "azure_openai" | "ollama" | — | Which AI provider to use. |
| ai.api_key | string | — | API key for your AI provider. Not needed for Ollama. |
| ai.model | string | provider default | Override the default model. For Azure, this is the deployment name. |
| ai.base_url | URL | — | Required for azure_openai and ollama. Azure: your resource URL. Ollama: http://host.docker.internal:11434 |
| features | |||
| features.jira.read | boolean | — | Enable reading Jira issues, comments, boards, sprints. |
| features.jira.write | boolean | — | Enable creating/editing issues, comments, transitions, attachments. |
| features.confluence.read | boolean | — | Enable reading Confluence pages, spaces, search. |
| features.confluence.write | boolean | — | Enable creating/editing pages and attachments. |
| features.bitbucket.read | boolean | — | Enable reading repos, PRs, branches, commits, diffs. |
| features.bitbucket.write | boolean | — | Enable creating branches and PR comments. |
| General | |||
| scrub_pii | boolean | false | Detect and redact emails, phone numbers, and names before sending to AI. Recommended for healthcare, finance, and government. |
| dev_mode | boolean | false | Skip license validation. For local development only — do not use in production. |
| log_level | "debug" | "info" | "warn" | "error" | "info" | Logging verbosity. Use "debug" for troubleshooting. |
| port_chat | number | 3000 | Port for the web chat UI. |
| port_mcp | number | 3001 | Port for the MCP transport (IDE integration). |
Atlassian Data Center
Set platform: "datacenter" and base_url to your server URL (e.g., https://jira.yourcompany.com). Two authentication options:
- PAT (
auth_method: "pat") — user enters a Personal Access Token at login. Recommended. - Basic auth (
auth_method: "basic") — user enters their username + password at login.
If your Jira, Confluence, and Bitbucket run on different servers, set each URL individually using jira_url, confluence_url, and bitbucket_url. If they share one URL, only base_url is needed.
Foxbridge uses the REST API v2 endpoints for Data Center.
AI Providers
Anthropic Claude
ai:
provider: "anthropic"
api_key: "sk-ant-api03-..."
model: "claude-sonnet-4-20250514" # optional, defaults to latest Sonnet Best for tool use. Vision (image analysis) is supported with Anthropic. Get an API key at console.anthropic.com.
OpenAI
ai:
provider: "openai"
api_key: "sk-..."
model: "gpt-4o" # optional Supports GPT-4o, GPT-4, and other OpenAI models. Get an API key at platform.openai.com.
Azure OpenAI
ai:
provider: "azure_openai"
api_key: "your-azure-key"
base_url: "https://your-resource.openai.azure.com"
model: "your-deployment-name" # deployment name, not model name For organizations using Azure's OpenAI Service. The model must be your deployment name, not the model name. The base_url is your Azure resource endpoint.
Ollama (Local / Air-Gapped)
ai:
provider: "ollama"
base_url: "http://host.docker.internal:11434"
model: "llama3.1" # any model you've pulled No API key needed. Data never leaves your network. Install Ollama and pull a model (ollama pull llama3.1). The host.docker.internal hostname lets the Docker container reach Ollama on your host machine.
Available Tools (40+)
Jira (17 read + 11 write)
Read: Search issues (JQL), read issue details, comments, transitions, boards, sprints, sprint issues, projects, fields, priorities, statuses, attachments, worklogs, issue types, users.
Write: Create/update/delete issues, add/update/delete comments, transition workflows, assign issues, link issues, add attachments, log work.
Confluence (7 read + 5 write)
Read: Search content (CQL), read pages and blog posts, list spaces, get page children and attachments.
Write: Create/update pages, add attachments.
Bitbucket (8 read + 2 write)
Read: List repositories, branches, pull requests, commits, read file contents, diffs, PR comments.
Write: Create branches, add PR comments.
Write tools are disabled by default. Enable them per-product in the features section of foxbridge.yaml. The AI always shows a preview and asks for confirmation before executing bulk operations.
File Upload
Users can drag-and-drop or attach files in the chat for AI analysis or attachment to Atlassian items:
- Supported formats: CSV, XLSX, PDF, DOCX, PPTX, PNG, JPG, plain text, Markdown
- Max size: 25 MB per file, 5 files per message
- Use cases:
- "Turn this spreadsheet into Jira tickets" — parses CSV/XLSX, creates one ticket per row
- "Summarize this PDF" — extracts text and provides a summary
- "Attach this to PROJ-123" — uploads the file to a Jira issue
- "What's in this screenshot?" — image analysis (Anthropic only)
PII Scrubbing
Enable scrub_pii: true to automatically detect and redact personally identifiable information before it's sent to the AI provider. Detected patterns include:
- Email addresses
- Phone numbers
- Names (based on common patterns)
Recommended for healthcare, finance, government, and any deployment where ticket data may contain sensitive personal information. PII scrubbing happens in-memory before data leaves Foxbridge — your AI provider never sees the original PII.
Licensing
Foxbridge requires a license key to start. The key is validated on startup and revalidated every 6 hours. If the validation server is unreachable, a 72-hour grace period allows continued operation.
- Trial: 14 days, 10 concurrent users — get a trial key
- Team: 25 concurrent users
- Business: 100 concurrent users
- Enterprise: Unlimited users
Concurrent users = active sessions at the same time. When a user closes their browser, the session expires after 8 hours and frees a seat.
MCP / IDE Integration
Foxbridge exposes an MCP (Model Context Protocol) endpoint on port 3001. This lets you use Foxbridge tools from Claude Code, VS Code, Cursor, or any MCP-compatible client.
The MCP endpoint supports the same tools as the web chat — search Jira issues, read Confluence pages, etc. — directly from your IDE.
See the setup guide for configuration instructions.