Skip to content
Neubird AI Docs Neubird AI Docs Neubird AI Docs

Tool Reference

Tool Reference Overview

Section titled “Tool Reference Overview”

Complete reference for all 40 NeuBird MCP tools.

Tool Categories

Section titled “Tool Categories”

Projects (5 tools)

Section titled “Projects (5 tools)”

Create and manage NeuBird projects that organize connections and instructions.

Connections (10 tools)

Section titled “Connections (10 tools)”

Connect to AWS, Azure, GCP, Datadog, PagerDuty, and other platforms.

Investigations (11 tools)

Section titled “Investigations (11 tools)”

Investigate alerts, monitor real-time progress, get RCA results, and ask follow-up questions.

Instructions (7 tools)

Section titled “Instructions (7 tools)”

Create, test, and manage investigation instructions.

Analytics (4 tools)

Section titled “Analytics (4 tools)”

Track performance metrics, MTTR, and time saved.

Discovery (2 tools)

Section titled “Discovery (2 tools)”

Explore available resources and data sources.

Help (1 tool)

Section titled “Help (1 tool)”

Get interactive guidance and help.

Projects

Section titled “Projects”

Tools for managing NeuBird projects.

neubird_list_projects

Section titled “neubird_list_projects”

Lists all available projects.

Parameters:

  • include_inactive (boolean, optional): Include inactive projects

Example:

List my NeuBird projects

neubird_create_project

Section titled “neubird_create_project”

Creates a new NeuBird project.

Parameters:

  • name (string, required): Project name
  • description (string, optional): Project description
  • icon_style (string, optional): Icon style

Example:

Create a project called "Production"

neubird_get_project_details

Section titled “neubird_get_project_details”

Gets detailed information about a project.

Parameters:

  • project_uuid (string, optional): Project UUID (uses default if omitted)

Example:

Show me details for my Production project

neubird_update_project

Section titled “neubird_update_project”

Updates project properties.

Parameters:

  • project_uuid (string, optional): Project UUID
  • name (string, optional): New name
  • description (string, optional): New description

Example:

Rename project to "Production Environment"

neubird_delete_project

Section titled “neubird_delete_project”

Deletes a project (requires confirmation).

Parameters:

  • project_uuid (string, required): Project UUID
  • confirm (boolean, required): Must be true

Example:

Delete project abc-123-def-456

Connections

Section titled “Connections”

Tools for managing cloud and monitoring tool connections.

neubird_list_connections

Section titled “neubird_list_connections”

Lists all available connections.

Parameters:

  • include_inactive (boolean, optional): Include non-synced connections

Example:

Show me all my connections

neubird_create_aws_connection

Section titled “neubird_create_aws_connection”

Creates an AWS connection.

Parameters:

  • name (string, required): Connection name
  • aws_role_arn (string, required): IAM role ARN
  • aws_external_id (string, required): External ID
  • aws_regions (array, required): AWS regions

Example:

Create AWS connection with role arniam:role/NeuBirdReadOnly

neubird_create_datadog_connection

Section titled “neubird_create_datadog_connection”

Creates a Datadog connection.

Parameters:

  • name (string, required): Connection name
  • datadog_api_key (string, required): API key
  • datadog_app_key (string, required): Application key
  • datadog_endpoint (string, optional): Endpoint (default: datadoghq.com)

Example:

Create Datadog connection for Production

neubird_wait_for_connection_sync

Section titled “neubird_wait_for_connection_sync”

Waits for a connection to reach SYNCED state.

Parameters:

  • connection_uuid (string, required): Connection UUID
  • wait_for_completion (boolean, optional): Auto-poll until synced
  • max_wait_seconds (number, optional): Max wait time (default: 300)

Example:

Wait for my AWS connection to sync

neubird_add_connection_to_project

Section titled “neubird_add_connection_to_project”

Adds connections to a project.

Parameters:

  • project_uuid (string, optional): Project UUID
  • connection_uuids (array, required): Connection UUIDs to add

Example:

Add my [AWS](https://neubird.ai/agentic-ai-for-aws/) and Datadog connections to Production

neubird_list_project_connections

Section titled “neubird_list_project_connections”

Lists connections for a project.

Parameters:

  • project_uuid (string, optional): Project UUID

Example:

Show me connections for Production project

Investigations

Section titled “Investigations”

Tools for investigating alerts and getting RCA results.

neubird_list_sessions

Section titled “neubird_list_sessions”

Lists investigation sessions with powerful filtering.

Parameters:

  • project_uuid (string, optional): Project UUID
  • only_uninvestigated (boolean, optional): Show only uninvestigated alerts
  • page (number, optional): Page number
  • limit (number, optional): Results per page (max: 100)
  • date_from (string, optional): Start date filter
  • date_to (string, optional): End date filter
  • search_term (string, optional): Search by title
  • compact (boolean, optional): Compact format

Example:

Show me uninvestigated alerts from the last 24 hours

Getting Links: After listing investigations, you can request direct links:

Link for #2
Link for sessionID abc-123-def-456

neubird_investigate_alert

Section titled “neubird_investigate_alert”

START a new investigation for an uninvestigated alert.

Parameters:

  • alert_id (string, required): Alert ID from incident_info.id
  • project_uuid (string, optional): Project UUID

Example:

Investigate alert /aws/alerts/cpu-spike-123

Important: Use alert_id from uninvestigated incidents list.

Real-Time Progress: After starting an investigation, use neubird_get_investigation_status to monitor real-time progress. The investigation streams updates as it runs, showing you each step and data source consultation.

neubird_continue_investigation

Section titled “neubird_continue_investigation”

Ask follow-up questions on an already investigated session.

Parameters:

  • session_uuid (string, required): Session UUID from completed investigation
  • follow_up_prompt (string, required): Your question

Example:

Why did this happen? Has it happened before?

Important: Use session_uuid from investigated sessions, not alert_id.

neubird_get_investigation_status

Section titled “neubird_get_investigation_status”

Gets the current status and real-time progress of an investigation.

Parameters:

  • session_uuid (string, required): Session UUID

Returns: For in-progress investigations, this tool automatically connects to the live progress stream and provides:

  • Current step being executed
  • Progress percentage based on completed steps
  • Data sources being consulted
  • Step-by-step breakdown with chain of thought IDs
  • Total steps completed vs estimated total
  • Unique data sources consulted

For completed investigations, returns final status and summary.

Example:

Show me the status of this investigation

Output includes:

  • progress_percentage (0-100): Completion percentage
  • current_step: Human-readable description of current action
  • investigation_summary.unique_sources: List of data sources consulted
  • investigation_summary.steps[].step_id: Chain of thought ID for detailed lookup
  • investigation_summary.steps[].sources_consulted: Sources used for each step
  • investigation_summary.steps[].category: Step type (discovery, analysis, diagnosis, etc.)

neubird_get_rca

Section titled “neubird_get_rca”

Gets the complete Root Cause Analysis for an investigation.

Parameters:

  • session_uuid (string, required): Session UUID

Returns:

  • Incident summary
  • Root cause
  • Timeline
  • Corrective actions (with bash scripts)
  • Preventive measures
  • Business impact
  • Time saved

Example:

Show me the RCA for this investigation

Recommended: Use this FIRST after listing sessions.

neubird_get_chain_of_thought

Section titled “neubird_get_chain_of_thought”

Gets investigation reasoning steps.

Parameters:

  • session_uuid (string, required): Session UUID
  • category_filter (string, optional): Filter by category

Example:

Show me the chain of thought for this investigation

neubird_get_investigation_queries

Section titled “neubird_get_investigation_queries”

Gets detailed query execution logs.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

What queries were run during this investigation?

neubird_get_investigation_sources

Section titled “neubird_get_investigation_sources”

Gets data sources consulted during investigation.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

What data sources were checked?

neubird_get_follow_up_suggestions

Section titled “neubird_get_follow_up_suggestions”

Gets suggested follow-up questions.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

What follow-up questions should I ask?

neubird_get_rca_score

Section titled “neubird_get_rca_score”

Gets quality score for an RCA investigation.

Parameters:

  • session_uuid (string, required): Session UUID

Returns:

  • Accuracy scores (root cause, impact, timeline)
  • Completeness scores (data sources, remediation, prevention)
  • Qualitative feedback

Example:

Show me the quality score for this investigation

Instructions

Section titled “Instructions”

Tools for creating and testing investigation instructions.

neubird_list_project_instructions

Section titled “neubird_list_project_instructions”

Lists instructions for a project.

Parameters:

  • project_uuid (string, optional): Project UUID
  • instruction_type (string, optional): Filter by type
  • status (string, optional): Filter by status

Example:

Show me all active RCA instructions

neubird_create_project_instruction

Section titled “neubird_create_project_instruction”

Creates a new project instruction.

Parameters:

  • project_uuid (string, optional): Project UUID
  • type (enum, required): INSTRUCTION_TYPE_FILTER | SYSTEM | GROUPING | RCA
  • content (string, required): Instruction content
  • enabled (boolean, optional): Enable immediately

Instruction Types:

  • FILTER: Filter out noise
  • SYSTEM: Investigation context
  • GROUPING: Group related alerts
  • RCA: Investigation steps

Example:

Create a SYSTEM instruction about our architecture

neubird_validate_instruction

Section titled “neubird_validate_instruction”

Validates an instruction before applying.

Parameters:

  • content (string, required): Instruction content
  • type (enum, required): Instruction type
  • project_uuid (string, optional): Project context

Returns: Validated instruction with generated name and refined content

Example:

Validate this RCA instruction: "For database issues, check slow queries first"

neubird_apply_session_instruction

Section titled “neubird_apply_session_instruction”

Applies an instruction to a specific session for testing.

Parameters:

  • session_uuid (string, required): Session UUID
  • content (string, required): Instruction content
  • type (enum, required): Instruction type
  • validate_first (boolean, optional): Validate first (default: true)

Example:

Apply this instruction to session abc-123 for testing

neubird_rerun_session

Section titled “neubird_rerun_session”

Re-runs an investigation with applied instructions.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

Rerun this session with the new instruction

Analytics

Section titled “Analytics”

Tools for tracking performance and metrics.

neubird_inspect_session

Section titled “neubird_inspect_session”

Gets session metadata.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

Inspect session metadata for abc-123

neubird_get_session_report

Section titled “neubird_get_session_report”

Gets summary reports for sessions.

Parameters:

  • session_uuids (array, required): Session UUIDs
  • project_uuid (string, required): Project UUID

Example:

Show me reports for these 3 sessions

neubird_get_session_summary

Section titled “neubird_get_session_summary”

Gets detailed analysis and scoring.

Parameters:

  • session_uuid (string, required): Session UUID

Example:

Show me the session summary

neubird_get_incident_report

Section titled “neubird_get_incident_report”

Gets comprehensive incident statistics across ALL investigations.

Parameters: None

Returns:

  • MTTR
  • Time saved
  • Noise reduction
  • Organization-wide analytics

Example:

Show me our incident statistics

Discovery

Section titled “Discovery”

Tools for exploring available resources.

neubird_discover_project_resources

Section titled “neubird_discover_project_resources”

Aggregates ALL available resources across project connections.

Parameters:

  • project_uuid (string, optional): Project UUID
  • telemetry_type_filter (string, optional): Filter by telemetry type
  • connection_type_filter (string, optional): Filter by connection type

Example:

Show me all available log sources

neubird_list_connection_resource_types

Section titled “neubird_list_connection_resource_types”

Gets resource types for a connection type + telemetry type combination.

Parameters:

  • connection_type (string, required): Connection type
  • telemetry_type (string, required): Telemetry type

Example:

Show me AWS log resource types

Help

Section titled “Help”

neubird_get_guidance

Section titled “neubird_get_guidance”

Interactive help system with embedded knowledge base.

Parameters:

  • question (string, required): Your question
  • topic (enum, optional): Specific topic area

Topics:

  • connections - Setup and configuration
  • projects - Project management
  • investigations - How to investigate alerts
  • instructions - Creating and testing instructions
  • onboarding - Getting started
  • troubleshooting - Common issues

Example:

How do I create an AWS connection?

Quick Workflows

Section titled “Quick Workflows”

Investigate an Alert

Section titled “Investigate an Alert”
1. neubird_list_sessions (only_uninvestigated=true)
2. neubird_investigate_alert (with alert_id)
3. neubird_get_investigation_status (monitor real-time progress)
4. neubird_get_rca (get results when complete)
5. neubird_continue_investigation (optional follow-up)

Test an Instruction

Section titled “Test an Instruction”
1. neubird_validate_instruction
2. neubird_apply_session_instruction
3. neubird_rerun_session
4. neubird_get_rca (compare results)
5. neubird_create_project_instruction (if improved)

Complete Onboarding

Section titled “Complete Onboarding”
1. neubird_create_project
2. neubird_create_aws_connection
3. neubird_wait_for_connection_sync
4. neubird_add_connection_to_project
5. neubird_create_project_instruction (SYSTEM)
6. neubird_list_sessions (only_uninvestigated=true)
7. neubird_investigate_alert

Tool Count Summary

Section titled “Tool Count Summary”
  • Projects: 5 tools
  • Connections: 10 tools
  • Investigations: 11 tools
  • Instructions: 7 tools
  • Analytics: 4 tools
  • Discovery: 2 tools
  • Help: 1 tool
  • Additional: 3 tools (set_default_project, create_manual_investigation, get_investigation_status enhancements)

Total: 43 tools

See Also

Section titled “See Also”