Class CreativeAgentClient

Creative Agent Client - Specialized client for interacting with creative agents

Creative agents provide creative assembly and reusable creative-library services. Creative-library reads are canonical by default: each creative is identified by format_kind and, when applicable, format_option_ref.

Example

// Standard creative agent
const creativeAgent = new CreativeAgentClient({
  agentUrl: 'https://creative.adcontextprotocol.org/mcp'
});

const { creatives } = await creativeAgent.listCreatives({
  filters: { statuses: ['approved'] }
});
const images = creatives.filter(creative => creative.format_kind === 'image');

Index

Constructors

constructor

Methods

listFormatsLegacy findLegacyByDimensions findLegacyById listCreatives listCreativesLegacy getAgentUrl getClient

Constructors

constructor

new CreativeAgentClient(config: CreativeAgentClientConfig): CreativeAgentClient
Parameters
- config: CreativeAgentClientConfig
Returns CreativeAgentClient
- Defined in src/lib/core/CreativeAgentClient.ts:60

Methods

listFormatsLegacy

listFormatsLegacy(
params?: LegacyListCreativeFormatsRequest,
): Promise<LegacyCreativeFormat[]>
List a creative agent's legacy named-format catalog.

Canonical applications should discover seller-supported declarations through AgentClient.getProducts() and use format_options[]. This method exists for migration tooling that must inspect the old creative-agent catalog.
Parameters
- params: LegacyListCreativeFormatsRequest = {}
  Optional filtering parameters
Returns Promise<LegacyCreativeFormat[]>
Promise resolving to array of creative formats
Example
```
const formats = await creativeAgent.listFormatsLegacy();

// Find by dimensions
const banners = formats.filter(f =>
  f.renders?.[0]?.dimensions?.width === 300 &&
  f.renders?.[0]?.dimensions?.height === 250
);
```
Deprecated
Canonical applications discover format_options[] through seller products.
- Defined in src/lib/core/CreativeAgentClient.ts:97

findLegacyByDimensions

findLegacyByDimensions(
width: number,
height: number,
): Promise<LegacyCreativeFormat[]>
Find formats by dimensions
Parameters
- width: number
  Width in pixels
- height: number
  Height in pixels
Returns Promise<LegacyCreativeFormat[]>
Promise resolving to matching formats
Example
```
// Find all 300x250 formats
const mediumRectangles = await creativeAgent.findLegacyByDimensions(300, 250);
```
- Defined in src/lib/core/CreativeAgentClient.ts:124

findLegacyById

findLegacyById(formatId: string): Promise<LegacyCreativeFormat | undefined>
Find format by ID
Parameters
- formatId: string
  Format ID to search for
Returns Promise<LegacyCreativeFormat | undefined>
Promise resolving to matching format or undefined
Example
```
const format = await creativeAgent.findLegacyById('display_300x250_image');
if (format) {
  console.log(`Found: ${format.name}`);
}
```
- Defined in src/lib/core/CreativeAgentClient.ts:149

listCreatives

listCreatives(
    params?: CanonicalListCreativesRequest,
    inputHandler?: InputHandler,
    options?: CreativeAgentListTaskOptions,
): Promise<CanonicalListCreativesResponse>
List creatives in the agent's library
Parameters
- params: CanonicalListCreativesRequest = {}
  Optional filtering, sorting, and pagination parameters
- OptionalinputHandler: InputHandler
- Optionaloptions: CreativeAgentListTaskOptions
Returns Promise<CanonicalListCreativesResponse>
Promise resolving to canonical creatives (format_kind, never format_id)
Example
```
const result = await creativeAgent.listCreatives({
  filters: { statuses: ['approved'], has_variables: true },
  include_variables: true
});
const imageCreatives = result.creatives.filter(
  creative => creative.format_kind === 'image'
);
```
- Defined in src/lib/core/CreativeAgentClient.ts:171

listCreativesLegacy

listCreativesLegacy(
    params?: LegacyListCreativesRequest,
    inputHandler?: InputHandler,
    options?: TaskOptions,
): Promise<LegacyListCreativesResponse>
Return the unprojected creative-library wire response.
Parameters
- params: LegacyListCreativesRequest = {}
- OptionalinputHandler: InputHandler
- Optionaloptions: TaskOptions
Returns Promise<LegacyListCreativesResponse>
Deprecated
Compatibility-only escape hatch for migration and protocol tooling.
- Defined in src/lib/core/CreativeAgentClient.ts:194

getAgentUrl

getAgentUrl(): string
Get the agent URL

Returns string
- Defined in src/lib/core/CreativeAgentClient.ts:211

getClient

getClient(): SingleAgentClient
Get the underlying single-agent client for advanced operations

Returns SingleAgentClient
- Defined in src/lib/core/CreativeAgentClient.ts:218

Class CreativeAgentClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CreativeAgentClient

Methods

listFormatsLegacy

Parameters

Returns Promise<LegacyCreativeFormat[]>

Example

Deprecated

findLegacyByDimensions

Parameters

Returns Promise<LegacyCreativeFormat[]>

Example

findLegacyById

Parameters

Returns Promise<LegacyCreativeFormat | undefined>

Example

listCreatives

Parameters

Returns Promise<CanonicalListCreativesResponse>

Example

listCreativesLegacy

Parameters

Returns Promise<LegacyListCreativesResponse>

Deprecated

getAgentUrl

Returns string

getClient

Returns SingleAgentClient

Settings

On This Page