Skip to main content
Glama
playcanvas

PlayCanvas Editor MCP Server

Official
by playcanvas

list_assets

Retrieve and filter assets by type within the PlayCanvas Editor MCP Server to manage 3D web application resources efficiently.

Instructions

List all assets with the option to filter by type

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNoThe type of assets to list. If not specified, all assets will be listed.

Implementation Reference

  • The execution handler for the list_assets tool, which proxies the call to the WSS 'assets:list' endpoint with optional type filter.
    ({ type }) => {
        return wss.call('assets:list', type);
    }
  • Input schema for the list_assets tool: optional 'type' parameter enum for filtering by asset type.
    {
        type: z.enum(['css', 'cubemap', 'folder', 'font', 'html', 'json', 'material', 'render', 'script', 'shader', 'template', 'text', 'texture']).optional().describe('The type of assets to list. If not specified, all assets will be listed.')
    },
  • MCP tool registration block for 'list_assets', defining name, description, schema, and handler.
    mcp.tool(
        'list_assets',
        'List all assets with the option to filter by type',
        {
            type: z.enum(['css', 'cubemap', 'folder', 'font', 'html', 'json', 'material', 'render', 'script', 'shader', 'template', 'text', 'texture']).optional().describe('The type of assets to list. If not specified, all assets will be listed.')
        },
        ({ type }) => {
            return wss.call('assets:list', type);
        }
    );
  • src/server.ts:79-79 (registration)
    Calls registerAsset(mcp, wss) which invokes the tool registrations including list_assets.
    registerAsset(mcp, wss);
  • Backend implementation of the 'assets:list' WebSocket method, listing and filtering assets via PlayCanvas API, returning their JSON representations.
    wsc.method('assets:list', (type) => {
        let assets = api.assets.list();
        if (type) {
            assets = assets.filter((asset) => asset.get('type') === type);
        }
        log('Listed assets');
        return { data: assets.map((asset) => asset.json()) };
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool lists assets, implying a read-only operation, but doesn't mention potential side effects, permissions required, rate limits, or what the output format looks like. For a tool with no annotation coverage, this leaves significant gaps in understanding its behavior.

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, efficient sentence that front-loads the core purpose ('List all assets') and adds necessary detail ('with the option to filter by type'). There is no wasted verbiage, making it highly concise and well-structured.

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

Completeness3/5

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

Given the tool's low complexity (1 optional parameter) and high schema coverage, the description is adequate but incomplete. It lacks output schema information (not provided) and behavioral details like pagination or error handling, which are important for a list operation. However, it covers the basic purpose and parameter context sufficiently for minimal viability.

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

Parameters3/5

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

The description mentions filtering by type, which aligns with the single parameter in the input schema. Since schema description coverage is 100% (the parameter has a clear description and enum values), the description adds minimal value beyond what the schema provides, meeting the baseline score of 3 for high schema coverage.

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

Purpose4/5

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

The description clearly states the verb ('list') and resource ('assets'), and specifies the filtering capability ('with the option to filter by type'). It distinguishes from siblings like 'create_assets' or 'delete_assets' by indicating a read operation, though it doesn't explicitly differentiate from other list operations like 'list_entities'.

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 retrieving assets, possibly when needing to view available resources, but provides no explicit guidance on when to use this tool versus alternatives like 'list_entities' or 'store_search'. It mentions filtering by type, which hints at context, but lacks clear when-to-use or when-not-to-use statements.

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

Related 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/playcanvas/editor-mcp-server'

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