Available Tools
This page lists all tools exposed by the OpsHub Integration Manager MCP server. Your AI assistant uses these tools to perform operations on your OpsHub Integration Manager instance.
Note: You do not invoke these tools directly. Your AI assistant selects and calls the appropriate tools based on your natural language prompt. This reference helps you understand what is available and what each tool does.
Note: Delete operations are not supported via any MCP tool. See Known Behaviours and Limitations for details.
Planner tools
Planner tools guide the AI assistant through the correct sequence of steps before performing complex operations. The AI assistant calls the relevant planner automatically before executing create, update, or action operations on the corresponding resource.
system_planner
Provides a step-by-step execution plan for system operations (create, update, list, get). Ensures the AI assistant gathers all required inputs before calling system API tools.
mapping_planner
Provides a step-by-step execution plan for mapping operations (create, update, list, get). Ensures field metadata, entity types, and transformation requirements are resolved before creating or updating a mapping.
integration_planner
Provides a step-by-step execution plan for integration operations (create, update, list, get, activate, inactivate, execute).
folder_planner
Provides a step-by-step execution plan for folder operations (create, update, list, get).
schedules_planner
Provides a step-by-step execution plan for schedule operations (create, update, list, get).
health_checkup_planner
Guides the AI assistant through a comprehensive multi-stage health checkup of the OpsHub Integration Manager instance — covering integrations, systems, mappings, failures, and instance resource parameters. Produces a visual dashboard with colour-coded health status and prioritised recommendations.
failure_resolution_planner
Guides the AI assistant through a structured diagnostic process to identify the root cause of integration failures. Covers integration configuration, mapping, system connectivity, and permissions, and produces a step-by-step resolution plan.
reconciliation_planner
Provides a step-by-step execution plan for reconciliation operations (get, switch to reconcile mode, switch back to integration mode, change status, configure reconcile rules). Establishes the prerequisites a reconciliation needs and ensures the impact is stated to you before anything is changed.
failure_notification_planner
Provides a step-by-step execution plan for failure notification operations (create, update, get). Resolves the mail system and the notification conditions before a notification is configured.
reporting_planner
Provides a step-by-step execution plan for reporting operations (sync report, usage export, metrics export). Distinguishes answering a question about synchronised data from producing a file, so that a question is answered from sync data rather than by generating a report.
System tools
getSystemTypes
Lists all supported system types available in OpsHub Integration Manager with their system type IDs. Supports search by system name and pagination.
getSystemTypeTemplate
Retrieves the required fields and configuration template for a given system type. Used by the AI assistant to understand what inputs are needed before creating or updating a system.
get_systems_list
Lists all systems configured in the OpsHub Integration Manager instance with search, filter, and sort capabilities.
get_system
Retrieves full details of a specific system by its ID.
create_system
Creates a new system (endpoint) in OpsHub Integration Manager.
update_system
Updates an existing system's configuration by its ID.
Metadata tools
Metadata tools retrieve structural information about systems — such as available projects, entity types, fields, and lookup values. These are used by the AI assistant when building or validating mappings.
get_projects
Retrieves the list of projects available in a specific system.
get_entities
Retrieves the list of entity types (e.g., issues, defects, stories) available for a given system and project.
get_fields_meta
Retrieves field metadata for a given system and entity type, including field names, types, and whether they are required or read-only.
get_lookup_values
Retrieves the allowed values for a specific lookup-type field in a system (e.g., status values, priority values).
get_complex_fields_meta
Retrieves internal metadata for complex field types — comments, links, and attachments — for both systems in a mapping. Used to configure advanced field-level transformations.
Mapping tools
get_mappings_list
Lists all mappings configured in the instance with search, filter, and sort capabilities.
get_mapping
Retrieves the full configuration of a specific mapping by its ID, including all field mappings and transformation rules.
create_mapping
Creates a new mapping between two entity types.
update_mapping
Updates an existing mapping by its ID.
get_advanced_transformation_comment
Retrieves the advanced XSLT transformation scripts for comment field mapping, including user mention, entity mention, and comment XSLT scripts. Called after a base mapping is created when comment field mapping requires advanced configuration.
XSLT tools
XSLT tools provide reference guidance that the AI assistant uses when generating or validating advanced field-level transformations in mappings.
Advanced_XSLT_Transformation_Guidelines
Provides the strict rules and constraints that the AI assistant must follow when generating or updating advanced XSLT used in field mappings.
Core_Utility_Methods_Reference_for_advanced_XSLT
Provides the library of available utility method definitions that can be used within XSLT transformations for field mappings.
Integration tools
get_integrations_list
Lists all integrations configured in the instance with search, filter, and sort capabilities.
get_integration
Retrieves the full configuration of a specific integration by its ID, including project pairs, entity pairs, sync directions, and settings.
create_integration
Creates a new integration.
update_integration
Updates an existing integration by its ID.
execute_status_change
Changes the execution status of one or more integrations. Supports three actions: activate (enable the integration for scheduled sync), inactivate (disable the integration), and execute (trigger an immediate on-demand sync cycle).
get_advanced_config_settings_integration
Retrieves all advanced configuration settings available for a given integration and direction — including override parameters for read/write operations and criteria configuration.
Folder tools
get_folders_list
Lists all folders in the instance with search, filter, and sort capabilities.
get_folder
Retrieves details of a specific folder by its ID.
create_folder
Creates a new folder. The parent folder must exist.
update_folder
Updates an existing folder by its ID.
Schedule tools
get_schedules_list
Lists all schedules configured in the instance. Supports filtering by schedule type, status, and name.
get_schedule
Retrieves details of a specific schedule by its ID, including type, configuration, status, and next execution time.
create_schedule
Creates a new schedule for automating integration execution.
update_schedule
Updates an existing schedule by its ID.
Workflow tools
get_workflows
Lists all workflows available in the instance with search, filter, and sort capabilities. Workflows can be referenced when configuring integration settings.
Failure tools
get_global_failures_list
Lists global failures across all integrations with search, filter, and sort capabilities. Global failures indicate errors that stopped an entire integration cycle.
get_global_failure
Retrieves full details of a specific global failure by its ID, including the stack trace.
get_processing_failures_list
Lists processing failures with search, filter, and sort capabilities. Processing failures are record-level failures where a specific item failed to sync.
get_processing_failure
Retrieves full details of a specific processing failure by its ID. Can optionally include dependent failure records.
retry_processing_failures
Retries one or more processing failures, re-queuing the failed records for synchronization.
Failure notification tools
Failure notifications email a configured set of recipients when an integration starts failing. A notification is configured per integration and sends through a mail system (SMTP Mail Client) already configured in OpsHub Integration Manager.
get_failure_notification
Retrieves the failure notification configured for an integration. An integration with no notification configured is a valid state, and is reported as such rather than as an error.
create_failure_notification
Creates a failure notification for an integration, covering the recipients, the failure conditions, and the directions the notification applies to.
update_failure_notification
Updates the failure notification configured for an integration.
Note: Updating a notification replaces its configuration rather than merging into it. The AI assistant reads the existing configuration first so that recipients and conditions you did not mention are carried forward. Confirm the final recipient list when the assistant presents it.
Note: Deleting a failure notification is not supported via MCP. To remove one, use the OpsHub Integration Manager UI.
Reconciliation tools
Reconciliation compares entities that are already in sync between two systems and applies the differences it finds, according to the reconcile rules configured on the mapping.
get_reconciliation
Retrieves the reconciliation details for an integration group, including the entity pairs configured for reconciliation and their current state.
switch_to_reconcile_mode
Switches integrations into reconciliation mode. The integration must be inactive, reconcile rules must already be configured on the field mappings of the entity pairs, and a reconciliation workflow must exist.
switch_to_integration_mode
Switches integrations back to normal synchronisation. This stops any reconciliation currently in progress.
update_reconciliation_status
Changes the status of one or more reconciliations - including activating a reconciliation so that it starts running.
Note: Switching an integration into reconciliation mode stops it synchronising normally until it is switched back. Reconciliation also covers comments, attachments, and links where these are configured on the mapping, not only the mapped fields.
Note: Moving a reconciliation to EXPIRED cannot be undone.
Note: Reconcile rules are configured on the mapping, not on the reconciliation.
Reporting tools
Reporting tools answer questions about what has synchronised, and produce the usage and metrics reports as downloadable files.
get_sync_report_list
Retrieves synchronised entity information with search, filter, and sort capabilities. Each record pairs a source entity with its target entity and carries both IDs, both entity types, both project names, both sync states, the last read and last processed times, and the failure count. Use this to answer questions such as how many items have synced, which entity maps to which, whether an entity was deleted, and what synced over a given period.
get_chart_filter_values
Retrieves the filter values available for metrics reporting - the systems, projects, and entity types that can be filtered on. Called before exporting the metrics report to discover valid filter values.
export_usage_report
Exports the usage report as a ZIP file containing the last-six-months and last-one-year usage workbooks.
export_chart_report
Exports the metrics report as a spreadsheet file, for the supplied filters.
Note: The two export tools return a file to download, not data the AI assistant can read. If you ask a question about synchronised data, the assistant answers it from
get_sync_report_listrather than by generating a report and attempting to read it.
Note: How a returned file is presented depends on your MCP client. See Receiving exported files below.
Receiving exported files
The usage and metrics reports are returned over MCP as file content. MCP clients differ in how they present a returned file, so each export is returned in more than one form and your client uses whichever it supports:
Text summary
The file name, type, and size, stated in the assistant's reply. Every client shows this.
Download link
A link to the equivalent OpsHub Integration Manager REST endpoint, provided where the report is reachable through one. Available for the usage report.
Attached file
The file content itself, attached to the tool result.
Clients that render attachments - such as Claude Code - save the file directly. Clients that do not render binary attachments still show the text summary and the download link, and you can retrieve the report from there or from the OpsHub Integration Manager UI.
Note: An export above the size limit supported over MCP is refused with a message rather than truncated. Narrow the filters, or take the report from the OpsHub Integration Manager UI.
Health & diagnostics tools
get_oim_system_information
Retrieves complete details about the OpsHub Integration Manager instance — including OS, heap memory usage, disk space, database connection pool utilisation, HTTP thread pool usage, active thread count, log folder size, and global log level. Used during health checkup to assess instance resource health.
Last updated