Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

brand_list

List your organization's brands as slug + name + description, so an agent can pick one before loading its context.

Lists the Brands of your organization, newest first, as slug, name and description. The brand context itself is not returned — pick one here, then load it with brand_get.

That split is deliberate: brand context is prose, and returning all of it for every brand would crowd out the rest of the conversation.

Input

Field Type Required Description
limit number no The greatest number of rows in the answer, from 1 to 500. The default is 100.
cursor string no The nextCursor of the previous answer. Omit it to get the first page.

Output

{ brands: [...], nextCursor? }. Each brand is { slug, name, description }. Deleted brands are excluded. When nextCursor is present, more brands exist: call brand_list again with cursor set to that value.

Example

“Which brands do we have set up?”

brand_list({});
// → { brands: [{ slug: 'acme-running', name: 'Acme Running', description: 'DTC running shoes.' }] }

Errors

  • invalid_cursor — the cursor is not a nextCursor of this tool, with the same arguments. Send it with no change, or omit it.

Requires the brand:read scope.

Reference

List the active organization’s brands as slug + name + description, newest first. The brand context itself is not returned — pick a brand here, then load its context with brand_get. The answer holds at most limit rows (default 100, maximum 500). When it carries nextCursor, more rows exist: call this tool again with the same arguments and cursor set to that value. When it carries no nextCursor, you have every row.

Input

Argument Type Required Description
cursor string, at least 1 character no The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.
limit integer, 1 to 500 no The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request. Default: 100.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • invalid_cursor
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold brand:read. Auth & scopes lists each scope.

Annotations

A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.

  • Read-only. The tool changes nothing.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Was this page helpful?