CodebaseHQ MCP Server

Local setup required. This server has to be cloned and prepared on your machine before you register it in Claude Code.
1

Set the server up locally

Run this once to clone and prepare the server before adding it to Claude Code.

Run in terminal
git clone https://github.com/bdteo/CodebaseHQ
cd CodebaseHQ

Then follow the repository README for any remaining dependency or build steps before continuing.

2

Register it in Claude Code

After the local setup is done, run this command to point Claude Code at the built server.

Run in terminal
claude mcp add -e "CODEBASEHQ_ACCOUNT=${CODEBASEHQ_ACCOUNT}" -e "CODEBASEHQ_USERNAME=${CODEBASEHQ_USERNAME}" -e "CODEBASEHQ_API_KEY=${CODEBASEHQ_API_KEY}" codebasehq -- node "<FULL_PATH_TO_CODEBASEHQ>/dist/index.js"

Replace <FULL_PATH_TO_CODEBASEHQ>/dist/index.js with the actual folder you prepared in step 1.

Required:CODEBASEHQ_ACCOUNTCODEBASEHQ_USERNAMECODEBASEHQ_API_KEY+ 1 optional
README.md

Manage CodebaseHQ tickets and track project activity via natural language

CodebaseHQ MCP Server

An MCP (Model Context Protocol) server that gives Claude Code access to CodebaseHQ — a project management and ticketing platform. Read, search, create, and update tickets directly from Claude Code or any MCP-compatible client.

Features

  • List projects — browse all projects in your CodebaseHQ account
  • Search tickets — full query syntax (status, assignee, priority, type, etc.) with pagination
  • View ticket details — get complete ticket info with status/priority IDs for updates
  • Read comments — full conversation thread with author names and file attachments
  • Activity feed — see recent project activity (who created/updated what)
  • List team members — discover user IDs for assignment
  • Create tickets — create new tickets with type, priority, and assignee
  • Update tickets — add comments, change status/priority/assignee, rename tickets

Prerequisites

Setup

1. Get your API credentials

Go to CodebaseHQ → Settings → My Profile and note:

  • API Username — format: account/username (e.g. mycompany/john)
  • API Key — 40-character string

2. Set environment variables

Add to your shell config (e.g. ~/.zshrc, ~/.bashrc):

export CODEBASEHQ_ACCOUNT="your-account"       # the part before /
export CODEBASEHQ_USERNAME="your-username"      # the part after /
export CODEBASEHQ_API_KEY="your-api-key"
export CODEBASEHQ_DEFAULT_PROJECT="my-project"  # optional — skip the project param in every tool call

3. Clone and build

git clone https://github.com/bdteo/CodebaseHQ.git
cd CodebaseHQ
pnpm install
pnpm run build

4. Register with Claude Code

Pick one of the methods below.

Option A: CLI command (global)
claude mcp add codebasehq -- node /absolute/path/to/CodebaseHQ/dist/index.js

The server inherits environment variables from your shell, so the CODEBASEHQ_* vars you set in step 2 are picked up automatically.

Option B: Global config file

Add to ~/.claude.json:

{
  "mcpServers": {
    "codebasehq": {
      "command": "node",
      "args": ["/absolute/path/to/CodebaseHQ/dist/index.js"]
    }
  }
}
Option C: Project-scoped config

Create a .mcp.json in your project root (useful for sharing with a team):

{
  "mcpServers": {
    "codebasehq": {
      "command": "node",
      "args": ["/absolute/path/to/CodebaseHQ/dist/index.js"],
      "env": {
        "CODEBASEHQ_ACCOUNT": "${CODEBASEHQ_ACCOUNT}",
        "CODEBASEHQ_USERNAME": "${CODEBASEHQ_USERNAME}",
        "CODEBASEHQ_API_KEY": "${CODEBASEHQ_API_KEY}",
        "CODEBASEHQ_DEFAULT_PROJECT": "${CODEBASEHQ_DEFAULT_PROJECT}"
      }
    }
  }
}

The ${VAR} syntax references your shell environment variables — no secrets in the file.

5. Verify

Restart Claude Code, then ask:

"List my CodebaseHQ projects"

If the server connects, you'll see your projects. If not, check Troubleshooting.

Tools

Tool Type Description
list_projects Read List all projects with ticket counts
search_tickets Read Search/list tickets with query syntax and pagination
get_ticket Read Full ticket detail by ID (includes field IDs for updates)
get_ticket_notes Read Comments, change history, and attachments
get_activity Read Recent project activity feed
list_users Read Team members with IDs for assignment
create_ticket Write Create a new ticket
update_ticket Write Add comment and/or change status, priority, assignee

Search Query Syntax

The search_tickets tool supports CodebaseHQ's query syntax:

status:open                    # by status
assignee:me                    # your tickets
priority:high                  # by priority
type:bug                       # Bug, Feature, or Task
category:General               # by category
sort:updated order:desc        # sorting
not-status:closed              # negation
assignee:me status:open        # combine filters

Usage Examples

Ask Claude things like:

  • "Show me all open tickets"
  • "What tickets are assigned to me?"
  • "Show me ticket #23 and its comments"
  • "What happened recently on the project?"
  • "Create a bug ticket for the login page issue"
  • "Mark ticket #5 as closed with a comment"
  • "Who's on the team? Assign ticket #10 to Mario"

Architecture

src/
├── index.ts            # MCP server, tool definitions, request handlers
├── codebasehq-api.ts   # HTTP client (JSON responses, XML write bodies, rate limiting)
└── types.ts            # TypeScript types for API responses

Tools (8)

list_projectsList all projects with ticket counts
search_ticketsSearch/list tickets with query syntax and pagination
get_ticketFull ticket detail by ID
get_ticket_notesComments, change history, and attachments
get_activityRecent project activity feed
list_usersTeam members with IDs for assignment
create_ticketCreate a new ticket
update_ticketAdd comment and/or change status, priority, assignee

Environment Variables

CODEBASEHQ_ACCOUNTrequiredThe account part of your API username
CODEBASEHQ_USERNAMErequiredThe username part of your API username
CODEBASEHQ_API_KEYrequiredYour 40-character API key
CODEBASEHQ_DEFAULT_PROJECTOptional default project name

Configuration

claude_desktop_config.json
{"mcpServers": {"codebasehq": {"command": "node", "args": ["/absolute/path/to/CodebaseHQ/dist/index.js"], "env": {"CODEBASEHQ_ACCOUNT": "your-account", "CODEBASEHQ_USERNAME": "your-username", "CODEBASEHQ_API_KEY": "your-api-key"}}}}

Try it

Show me all open tickets assigned to me.
Show me ticket #23 and its comments.
What happened recently on the project?
Create a bug ticket for the login page issue.
Mark ticket #5 as closed with a comment.

Frequently Asked Questions

What are the key features of CodebaseHQ?

Browse and list all projects in your CodebaseHQ account. Search tickets using full query syntax with pagination. View complete ticket details and conversation threads. Create new tickets with custom priority and assignment. Update existing tickets including status, priority, and comments.

What can I use CodebaseHQ for?

Quickly checking the status of assigned tasks without leaving the IDE. Updating ticket progress and adding comments during a coding session. Reviewing recent project activity to stay aligned with team progress. Creating bug reports directly from the terminal when an issue is discovered.

How do I install CodebaseHQ?

Install CodebaseHQ by running: claude mcp add codebasehq -- node /absolute/path/to/CodebaseHQ/dist/index.js

What MCP clients work with CodebaseHQ?

CodebaseHQ works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep CodebaseHQ docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Need the old visual installer? Open Conare IDE.
Open Conare