Tools Reference
BrinqaIQ exposes 30 tools accessible through both the BrinqaIQ Assistant chat UI and the MCP integration. The table below lists every tool with its classification and links to the relevant capability page for deeper coverage.
Table 1: BrinqaIQ tools
| Tool | What it does | Annotation | Deep dive |
|---|---|---|---|
bql.fromNaturalLanguage | Generate a BQL query from a natural-language prompt. | Read-only | BQL |
bql.execute | Run a BQL query and return the first page of results. | Read-only | BQL |
bql.results | Fetch the next page of results from an executed query. | Read-only | BQL |
docs.search | Search Brinqa Platform documentation and return matching passages with source URLs. | Read-only | Documentation Search |
cve.lookup | Look up CVE details — severity, affected products, remediation context. | Read-only | CVE Explorer |
dataModels.list | List the data models configured in your Brinqa Platform. | Read-only | — |
dataModels.get | Fetch the full attribute schema for one data model. | Read-only | — |
flows.list | List the Flow Definitions enabled for API and MCP access in your tenant. | Read-only | Flow & Automation Management |
flows.get | Fetch full metadata for one Flow Definition (enabled for API and MCP access) by name or id. A flow that exists but is not enabled returns an actionable error. | Read-only | Flow & Automation Management |
flows.running | List Flow instances that are currently running (not yet terminal). | Read-only | Flow & Automation Management |
flows.history | Get the per-step execution history of a flow run by transactionId. | Read-only | Flow & Automation Management |
flows.buttonFlows | List the button flows available for a data model, or for one specific record. | Read-only | Flow & Automation Management |
flows.buttonFlowFields | Return the launch input fields of one button flow on a data model. | Read-only | Flow & Automation Management |
automations.list | List every configured Automation in your tenant. | Read-only | Flow & Automation Management |
automations.get | Fetch full metadata for one Automation by name or id. | Read-only | Flow & Automation Management |
entities.search | Find a named flow, automation, or data model by name. Returns matching entities across domains. | Read-only | — |
entities.launch | Launch a named flow or automation, or a button flow on a data model. Creates real work. | ⚠ Destructive | Flow & Automation Management |
automation.status | Get the current status of a running execution by transactionId. | Read-only | Flow & Automation Management |
automation.cancel | Cancel an in-flight execution by transactionId. | ⚠ Destructive | Flow & Automation Management |
automation.resume | Resume a paused execution by transactionId. | ⚠ Destructive | Flow & Automation Management |
comments.list | List comments on one Brinqa entity, or across an entire data model. | Read-only | Comments |
comments.search | Find comments by their text, across all records or scoped to one data model. | Read-only | Comments |
comments.add | Add a new comment to an entity. | Mutating | Comments |
comments.update | Edit an existing comment by id. | ⚠ Destructive | Comments |
comments.delete | Delete a comment by id. | ⚠ Destructive | Comments |
dataset.create | Create one record of a data model. | Mutating | Dataset Write |
dataset.update | Update one record by id. | ⚠ Destructive | Dataset Write |
dataset.delete | Delete one record by id. | ⚠ Destructive | Dataset Write |
dataset.bulkUpdate | Set one attribute on every record matched by a BQL query. | ⚠ Destructive | Dataset Write |
findings.createTicket | Create one remediation ticket from a selection of findings. | ⚠ Destructive | Ticketing |
note
The ⚠ Destructive annotation surfaces a confirmation prompt in Claude Desktop and other annotation-aware MCP clients before the tool runs. Read-only and Mutating tools run without a prompt.