Skip to main content
Glama

openart_list_characters

Read-only

Retrieve a complete list of all characters and avatars from your OpenArt account.

Instructions

List all characters/avatars in the user's OpenArt account.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The actual handler function `listCharacters` that navigates to the OpenArt characters page and scrapes the character cards using Playwright.
    export async function listCharacters(): Promise<Character[]> {
      const page = await newPage();
      try {
        await page.goto(`${BASE_URL}/suite/characters-and-worlds`);
        await page.waitForLoadState("networkidle");
    
        // TODO: replace with real selectors after inspecting OpenArt UI.
        // Use `npx playwright codegen https://openart.ai/suite/characters-and-worlds`
        const cards = await page.locator('[data-character-card]').all();
    
        const results: Character[] = [];
        for (const card of cards) {
          const id = (await card.getAttribute("data-character-id")) || "";
          const name = (await card.locator(".character-name").textContent())?.trim() || "";
          const thumb = await card.locator("img").first().getAttribute("src");
          results.push({
            id,
            name,
            thumbnail_url: thumb || undefined,
            url: `${BASE_URL}/character/${id}`,
          });
        }
        return results;
      } finally {
        await page.close();
      }
    }
  • Schema definition for openart_list_characters: no required input, readOnlyHint + openWorldHint annotations.
    const tools = [
      {
        name: "openart_list_characters",
        description: "List all characters/avatars in the user's OpenArt account.",
        inputSchema: { type: "object", properties: {}, required: [] },
        annotations: { readOnlyHint: true, openWorldHint: true },
      },
  • src/index.ts:88-92 (registration)
    Registration/dispatch in CallToolRequestSchema handler: routes 'openart_list_characters' to listCharacters().
    let result: unknown;
    switch (name) {
      case "openart_list_characters":
        result = await listCharacters();
        break;
  • Helper `newPage()` used by listCharacters to create a Playwright page with an authenticated context.
    export async function newPage(): Promise<Page> {
      const ctx = await getContext();
      return ctx.newPage();
    }
  • The `Character` interface returned by listCharacters.
    export interface Character {
      id: string;
      name: string;
      thumbnail_url?: string;
      url: string;
    }
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint and openWorldHint. The description adds no further behavioral details beyond the account context, which is minimally informative. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence with front-loaded purpose. Every word is useful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list operation with no parameters and full annotation coverage, the description is complete enough. No return value explanation is needed given the tool's transparency.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so the schema coverage is 100%. Per the rule, baseline is 4 as the description need not add parameter info.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists all characters/avatars in the user's account. It uses a specific verb+resource structure and is distinct from siblings like 'get' (single) and 'create'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for listing all characters but does not provide explicit when-to-use guidance or mention alternatives such as 'get_character' for individual retrieval.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jbertus/openart-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server