notes#

Browse notes resource actions that can be discovered, described, and executed through the Brandwave MCP server.

Capability flow

Connect to the Brandwave MCP server via OAuth, then use discover-brandwave-capabilities, describe-brandwave-action, and execute-brandwave-action to work with these actions.

list-notes#

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

Read-onlyIdempotent

Example prompt#

text
List all notes in my organization.

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
entityType'activity' | 'campaign' | 'creator'RequiredType of entity to list notes for.
entityIdstring (UUID)RequiredEntity identifier to list notes for.

Response#

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

Underlying SDK method: bw.notes.list(params)

Scoping required

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

get-note#

Retrieve a single note by ID.

Read-onlyIdempotent

Example prompt#

text
Show me the details for this note.

Parameters#

NameTypeRequiredDescription
idstring (UUID)RequiredNote identifier.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes({ id })

create-note#

Create a new note attached to an entity.

Example prompt#

text
Create a new note.

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
entityType'activity' | 'campaign' | 'creator'RequiredType of entity to attach the note to.
entityIdstring (UUID)RequiredEntity identifier to attach the note to.
contentstringRequiredNote content (plain text or markdown).
createdBystring (UUID) | nullUser identifier who created the note.
createdByNamestringDisplay name of the note creator (max 255 characters).

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.create(params)

update-note#

Update a note's content.

Example prompt#

text
Update the note.

Parameters#

NameTypeRequiredDescription
noteIdstring (UUID)RequiredNote identifier to update.
contentstringRequiredUpdated note content.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.update(params)

delete-note#

Delete a note and remove it from its parent entity.

Destructive

Example prompt#

text
Delete this note.

Parameters#

NameTypeRequiredDescription
noteIdstring (UUID)RequiredNote identifier to delete.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.delete(params)