Notes#

See how an AI assistant can help with notes in Brandwave, including example prompts and the details it may ask for.

Using your AI assistant

Connect to the Brandwave MCP server, then ask your AI assistant in natural language. It will choose the right Brandwave task and ask for any details it needs.

List notes#

List notes for an entity, ordered by most recent first.

Tool name: list_notes. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

Example prompt#

text

List all notes in my organization.

Details to provide#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
entityType	`'activity' \| 'campaign' \| 'creator'`	Required	Type of entity to list notes for.
entityId	`string (UUID)`	Required	Entity identifier to list notes for.

What you'll get back#

Returns { items, totalCount, facets, _meta } with paginated results.

Scoping required

You must pass entityType ('activity', 'campaign', or 'creator') and entityId to scope the list.

Get note#

Retrieve a single note by ID.

Tool name: get_note. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

Example prompt#

text

Show me the details for this note.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	Note identifier.

What you'll get back#

Returns { data, _meta } with the result.

Create note#

Create a new note attached to an entity.

Tool name: create_note. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.

Example prompt#

text

Create a new note.

Details to provide#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
entityType	`'activity' \| 'campaign' \| 'creator'`	Required	Type of entity to attach the note to.
entityId	`string (UUID)`	Required	Entity identifier to attach the note to.
content	`string`	Required	Note content (plain text or markdown).
createdBy	`string (UUID) \| null`	—	User identifier who created the note.
createdByName	`string`	—	Display name of the note creator (max 255 characters).

What you'll get back#

Returns { data, _meta } with the result.

Update note#

Update a note's content.

Tool name: update_note. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

Example prompt#

text

Update the note.

Details to provide#

Name	Type	Required	Description
noteId	`string (UUID)`	Required	Note identifier to update.
content	`string`	Required	Updated note content.

What you'll get back#

Returns { data, _meta } with the result.

Delete note#

Delete a note and remove it from its parent entity.

Tool name: delete_note. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

Example prompt#

text

Delete this note.

Details to provide#

Name	Type	Required	Description
noteId	`string (UUID)`	Required	Note identifier to delete.

What you'll get back#

Returns { data, _meta } with the result.