Skip to main content
Version: v12

Comments

BrinqaIQ can add, read, update, delete, and search comments on Brinqa records. This capability is available in two ways:

  • BrinqaIQ Assistant (chat UI): ask in natural language to read, write, or search comments. BrinqaIQ handles the orchestration in the conversation.
  • MCP integration: the comment tools let any MCP-compatible AI client manage comments from agent prompts without leaving the client. See MCP Integration for setup.

Comments work on any record whose data model defines a comment attribute, such as Finding, Ticket, CveRecord, or SecurityAdvisory. Every operation runs with the permissions of the user account tied to your API token, so an agent only ever sees or changes comments on records you can already access.

How it works​

BrinqaIQ groups comment operations into three areas:

  • Read: list the comments on one record, list every comment across a data model, or search comments by their text. The tools are comments.list and comments.search.
  • Write: add a new comment to a record with comments.add.
  • Edit and remove: change or delete a comment you authored with comments.update and comments.delete.

Each result identifies its parent record, so an agent can move from a comment to the record it belongs to.

Read comments​

comments.list reads the comments on a single record when you give it a record id, and reads every comment across a data model when you omit the record id (the model-wide listing is paginated, so the agent shows one page and you can ask for more). comments.search finds comments by their body text, either across all records or scoped to one data model.

Example agent prompts:

Show me the comments on Finding 1847261953084.

Show all comments on Tickets.

Search Ticket comments that mention "false positive".

The agent calls comments.list for the first two prompts (with a record id, then without one for the model-wide listing) and comments.search for the last, then presents the matching comments and the records they belong to.

Add a comment​

comments.add posts a new comment on a record identified by its data model and record id.

Example agent prompt:

Add a comment to Finding 1847261953084 saying "investigating, ETA Friday".

The agent calls comments.add and confirms the new comment.

Update or delete a comment​

comments.update changes the text of a comment, and comments.delete removes one. You can only update or delete comments you authored. Because both change stored data, an annotation-aware client (such as Claude Desktop) shows a confirmation prompt before the tool runs, so the change never happens without your approval.

Example agent prompts:

Update comment 1847262100451 on that Finding to add "owner notified".

Delete comment 1847262100899 on Ticket 1847261888777.

The agent calls comments.update or comments.delete, and the client asks you to confirm before the change is applied.