Skip to main content
Glama
webflow

Webflow

Official
by webflow

List Components

components_list

Retrieve all components from a Webflow site with metadata including IDs, names, and versions for inventory management and integration purposes.

Instructions

List all components in a site. Returns component metadata including IDs, names, and versions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
site_idYesUnique identifier for the Site.
limitNoMaximum number of records to be returned (max limit: 100)
offsetNoOffset used for pagination if the results have more than limit records.

Implementation Reference

  • The handler function for the 'components_list' tool, which calls the Webflow API to list components for a given site, handles pagination with limit and offset, and formats the response or error.
    async ({ site_id, limit, offset }) => {
      try {
        const response = await getClient().components.list(
          site_id,
          {
            limit,
            offset,
          },
          requestOptions
        );
        return formatResponse(response);
      } catch (error) {
        return formatErrorResponse(error);
      }
    }
  • Zod input schema defining parameters for the components_list tool: site_id (required), limit and offset (optional).
    inputSchema: z.object({
      site_id: z.string().describe("Unique identifier for the Site."),
      limit: z
        .number()
        .optional()
        .describe(
          "Maximum number of records to be returned (max limit: 100)"
        ),
      offset: z
        .number()
        .optional()
        .describe(
          "Offset used for pagination if the results have more than limit records."
        ),
    }),
  • Registration of the 'components_list' MCP tool, including title, description, input schema, and inline handler function.
    server.registerTool(
      "components_list",
      {
        title: "List Components",
        description:
          "List all components in a site. Returns component metadata including IDs, names, and versions.",
        inputSchema: z.object({
          site_id: z.string().describe("Unique identifier for the Site."),
          limit: z
            .number()
            .optional()
            .describe(
              "Maximum number of records to be returned (max limit: 100)"
            ),
          offset: z
            .number()
            .optional()
            .describe(
              "Offset used for pagination if the results have more than limit records."
            ),
        }),
      },
      async ({ site_id, limit, offset }) => {
        try {
          const response = await getClient().components.list(
            site_id,
            {
              limit,
              offset,
            },
            requestOptions
          );
          return formatResponse(response);
        } catch (error) {
          return formatErrorResponse(error);
        }
      }
    );
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the action 'List all components' and return types, but lacks details on permissions, rate limits, pagination behavior (beyond what the schema implies), or whether it's a read-only operation. For a list tool with zero annotation coverage, this is a significant gap in transparency about how the tool behaves in practice.

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 action ('List all components in a site') and follows with return details. There's no wasted verbiage, and it's appropriately sized for a simple list tool, making it easy for an agent to parse quickly.

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 (a list operation), 100% schema coverage, and no output schema, the description is minimally adequate. It covers what the tool does and what it returns, but lacks context on behavioral aspects like pagination handling or error conditions. For a tool with no annotations, it should provide more guidance on usage and limitations to be fully complete.

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?

Schema description coverage is 100%, so the schema already documents all three parameters (site_id, limit, offset) with clear descriptions. The description adds no additional parameter semantics beyond what's in the schema, such as explaining the relationship between limit and offset or default values. Baseline 3 is appropriate when the schema does the heavy lifting.

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 'components in a site', specifying it returns metadata including IDs, names, and versions. It distinguishes from siblings like 'components_get_content' or 'components_get_properties' by focusing on listing all components rather than getting specific content or properties. However, it doesn't explicitly differentiate from 'collections_list' or 'pages_list' in terms of resource type, which slightly reduces specificity.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, such as needing a valid site_id, or compare it to sibling tools like 'components_get_content' for detailed component data. There's no explicit when/when-not or alternative usage context, leaving the agent to infer based on tool names alone.

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/webflow/mcp-server'

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