How to integrate Bugherd MCP with OpenAI Agents SDK

This guide walks you through connecting Bugherd to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Bugherd agent that can list all active bugherd projects, create a new project for website feedback, add a comment to task by id through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Bugherd account through Composio's Bugherd MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Bugherd logoBugherd
Api Key

Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes.

26 Tools

Introduction

This guide walks you through connecting Bugherd to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Bugherd agent that can list all active bugherd projects, create a new project for website feedback, add a comment to task by id through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Bugherd account through Composio's Bugherd MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Bugherd with

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Bugherd
  • Configure an AI agent that can use Bugherd as a tool
  • Run a live chat session where you can ask the agent to perform Bugherd operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

What is the Bugherd MCP server, and what's possible with it?

The Bugherd MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Bugherd account. It provides structured and secure access to your Bugherd workspace, so your agent can perform actions like creating tasks, managing projects, posting comments, and inviting team members—all on your behalf.

  • Visual bug reporting and task creation: Instantly add new tasks to any project, capturing detailed bug reports or website feedback directly from your team or clients.
  • Project management and workflow customization: Create new projects, add workflow columns, and delete projects when they’re no longer needed to keep your bug tracking organized and up-to-date.
  • Collaboration and discussion: Add comments to tasks, attach files, and keep all stakeholders in the loop with contextual feedback and documentation.
  • Team and guest access management: Seamlessly invite members or guests to projects so the right people can track, manage, and resolve issues together.
  • Webhook automation and notifications: Set up webhooks to receive real-time notifications for events like task creation or new comments, helping you automate downstream workflows.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Bugherd project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Bugherd.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Bugherd
const session = await composio.create(userId as string, {
  toolkits: ['bugherd'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only bugherd.
  • The router checks the user's Bugherd connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Bugherd.
  • This approach keeps things lightweight and lets the agent request Bugherd tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Bugherd. Help users perform Bugherd operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Bugherd and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Bugherd operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Bugherd.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Bugherd and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['bugherd'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Bugherd. Help users perform Bugherd operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Bugherd MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Bugherd.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS

Supported Tools

Every Bugherd action and event your agent gets out of the box.

Add Guest to Project

Tool to add a guest (client) to a project.

Add Member to Project

Tool to add a member to a project in BugHerd.

Create Attachment

Tool to add a new attachment to a task using an existing URL.

Create Column

Tool to create a new column in a project.

Create Comment

Tool to add a new comment to a task.

Create Project

Tool to create a new project.

Create Task

Tool to add a new task in a project.

Create Webhook

Tool to create a new webhook for real-time event notifications.

Delete Project

Tool to delete a project.

List Active Projects

Tool to list all active projects in your BugHerd account.

List Attachments

Tool to list all attachments for a task.

List Columns

Tool to list all columns for a project.

List Projects

Retrieves a paginated list of all projects in your BugHerd account.

List Project Tasks

Tool to list tasks within a specific BugHerd project with optional server-side filters (status/column, assignee, tag, priority, date filters) and pagination.

List Users

Tool to list all users in your account.

List Webhooks

Tool to list all installed webhooks.

Show Attachment

Tool to retrieve details of a specific attachment.

Show Column

Tool to show details of a specific column.

Show Organization

Tool to retrieve your BugHerd organization details.

Show Project Details

Retrieves full details of a specific BugHerd project by ID.

Show User Projects

Tool to list all projects a specific user has access to.

Show User Tasks

Retrieves all tasks created by or assigned to a specific user, grouped by project.

Update Column

Tool to update a column in a project.

Update Project

Update settings for an existing BugHerd project.

Update Task

Tool to update a task in a project.

Upload Attachment

Tool to upload a new attachment and add it to a specific task.

FAQ

Frequently asked questions

With a standalone Bugherd MCP server, the agents and LLMs can only access a fixed set of Bugherd tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Bugherd and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Bugherd tools.

Yes, absolutely. You can configure which Bugherd scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Bugherd data and credentials are handled as safely as possible.

Start with Bugherd.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Bugherd tool your agent needs.Free to start.

Start building