instabug-mcp-server

abdrahmansoltan/instabug-mcp-server

3.1

If you are the rightful owner of instabug-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to dayong@mcphub.com.

The Instabug MCP Server is a Model Context Protocol server that integrates with Instabug's systems to manage bug reports, crash analytics, and user feedback.

Tools
8
Resources
0
Prompts
0

Instabug MCP Server

A Model Context Protocol (MCP) server that provides AI assistants with powerful tools to interact with Instabug's bug reporting, crash analytics, and user feedback systems.

Features

This MCP server provides the following capabilities:

🐛 Bug Management

  • get_bugs - Retrieve bugs with filtering by status, priority, or tags
  • get_bug_details - Get detailed information about specific bugs
  • update_bug_status - Change bug status and add comments
  • create_bug_report - Create new bug reports with assignments

💥 Crash Analytics

  • get_crashes - Retrieve crash reports with filtering options
  • get_crash_details - Get detailed crash information and stack traces

📝 User Feedback

  • get_user_feedback - Access user ratings and feedback comments

📊 Analytics

  • get_app_analytics - Retrieve app usage statistics and performance metrics

Prerequisites

  • Node.js 18 or higher
  • Instabug account with API access
  • API tokens from your Instabug dashboard

Installation

  1. Clone this repository:
git clone <repository-url>
cd instabug-mcp-server
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env
  1. Edit .env file with your Instabug credentials:
INSTABUG_API_TOKEN=your_instabug_api_token_here
INSTABUG_APP_TOKEN=your_instabug_app_token_here
LOG_LEVEL=info

Getting Your Instabug API Tokens

  1. Log into your Instabug Dashboard
  2. Navigate to Settings > API
  3. Generate or copy your API Token
  4. Copy your App Token from the app settings

Usage

Building the Server

npm run build

Running the Server

npm start

Development Mode

npm run dev

Watch Mode (auto-rebuild)

npm run watch

MCP Client Configuration

To use this server with Claude Desktop or other MCP clients, add the following to your client configuration:

For Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "instabug": {
      "command": "node",
      "args": ["/path/to/instabug-mcp-server/build/index.js"]
    }
  }
}

For Development (using npm script)

{
  "mcpServers": {
    "instabug": {
      "command": "npm",
      "args": ["run", "dev"],
      "cwd": "/path/to/instabug-mcp-server"
    }
  }
}

Available Tools

Bug Management

get_bugs

Retrieve bugs from Instabug with optional filtering.

Parameters:

  • limit (number, optional): Number of bugs to retrieve (default: 20, max: 100)
  • status (string, optional): Filter by status (open, resolved, closed, in_progress)
  • priority (string, optional): Filter by priority (low, medium, high, critical)
  • tag (string, optional): Filter by tag name
get_bug_details

Get detailed information about a specific bug.

Parameters:

  • bug_id (string, required): The ID of the bug to retrieve
update_bug_status

Update the status of a bug.

Parameters:

  • bug_id (string, required): The ID of the bug to update
  • status (string, required): New status (open, resolved, closed, in_progress)
  • comment (string, optional): Optional comment for the status change
create_bug_report

Create a new bug report in Instabug.

Parameters:

  • title (string, required): Title of the bug report
  • description (string, required): Detailed description of the bug
  • priority (string, optional): Priority level (low, medium, high, critical)
  • tags (array, optional): Tags to categorize the bug
  • assignee_email (string, optional): Email of the person to assign

Crash Analytics

get_crashes

Retrieve crash reports with optional filtering.

Parameters:

  • limit (number, optional): Number of crashes to retrieve (default: 20, max: 100)
  • app_version (string, optional): Filter by app version
  • os_version (string, optional): Filter by OS version
  • device_model (string, optional): Filter by device model
get_crash_details

Get detailed information about a specific crash.

Parameters:

  • crash_id (string, required): The ID of the crash to retrieve

User Feedback

get_user_feedback

Retrieve user feedback and ratings.

Parameters:

  • limit (number, optional): Number of feedback items (default: 20, max: 100)
  • rating (number, optional): Filter by rating (1-5)
  • has_comment (boolean, optional): Filter for feedback with comments

Analytics

get_app_analytics

Get app analytics and usage statistics.

Parameters:

  • metric (string, required): Type of metric (sessions, crashes, bugs, user_feedback, performance)
  • start_date (string, optional): Start date (YYYY-MM-DD)
  • end_date (string, optional): End date (YYYY-MM-DD)

Example Queries

Here are some example queries you can use with this MCP server:

Bug Management Examples

  • "Show me all critical bugs that are currently open"
  • "Get details for bug ID 12345"
  • "Update bug 12345 status to resolved with comment 'Fixed in latest release'"
  • "Create a new bug report for login issues with high priority"

Crash Analytics Examples

  • "Show me recent crashes for iOS version 15.0"
  • "Get crash details for crash ID 67890"
  • "Show me crashes on iPhone 13 models"

User Feedback Examples

  • "Show me all 1-star ratings with comments"
  • "Get recent user feedback"

Analytics Examples

  • "Show me crash analytics for the last 30 days"
  • "Get session analytics from 2024-01-01 to 2024-01-31"

Development

Project Structure

src/
├── index.ts          # Main server implementation
├── types/            # TypeScript type definitions
└── utils/            # Utility functions

.vscode/
├── mcp.json          # MCP server configuration for debugging
└── settings.json     # VS Code settings

build/                # Compiled JavaScript output

VS Code Debugging

This project includes VS Code configuration for debugging the MCP server:

  1. Open the project in VS Code
  2. Install the recommended extensions when prompted
  3. Use the MCP debugging features provided by VS Code

Adding New Tools

To add new tools:

  1. Add the tool definition in the ListToolsRequestSchema handler
  2. Add the tool implementation in the CallToolRequestSchema handler
  3. Create the corresponding method in the InstabugMCPServer class
  4. Update this README with the new tool documentation

Troubleshooting

Common Issues

  1. Authentication errors: Verify your API tokens are correct and have the necessary permissions
  2. Network timeouts: Check your internet connection and Instabug API status
  3. Rate limiting: Instabug may rate limit API requests; the server includes retry logic for transient failures

Debug Logging

Set LOG_LEVEL=debug in your .env file for more verbose logging.

Testing the Server

You can test the server using the MCP Inspector:

npx @modelcontextprotocol/inspector npm run dev

API Rate Limits

Be aware of Instabug's API rate limits:

  • Respect the rate limits specified in Instabug's API documentation
  • The server implements appropriate error handling for rate limit responses
  • Consider caching responses for frequently accessed data

Security Considerations

  • Keep your API tokens secure and never commit them to version control
  • Use environment variables for all sensitive configuration
  • Regularly rotate your API tokens
  • Monitor API usage for any unusual activity

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

License

MIT License - see file for details.

Support

For issues related to: