Get Component Properties
components_get_propertiesRetrieve component properties, default values, and configuration details from Webflow sites to understand and manage component behavior.
Instructions
Get component properties including default values and configuration for a specific component.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | Unique identifier for the Site. | |
| component_id | Yes | Unique identifier for the Component. | |
| localeId | No | Unique identifier for a specific locale. Applicable when using localization. | |
| limit | No | Maximum number of records to be returned (max limit: 100) | |
| offset | No | Offset used for pagination if the results have more than limit records. |
Implementation Reference
- src/tools/components.ts:176-192 (handler)The handler function that implements the core logic of the 'components_get_properties' tool by fetching properties from the Webflow API.
async ({ site_id, component_id, localeId, limit, offset }) => { try { const response = await getClient().components.getProperties( site_id, component_id, { localeId, limit, offset, }, requestOptions ); return formatResponse(response); } catch (error) { return formatErrorResponse(error); } } - src/tools/components.ts:151-174 (schema)Zod input schema defining the parameters for the 'components_get_properties' tool: site_id (required), component_id (required), localeId/limit/offset (optional).
inputSchema: z.object({ site_id: z.string().describe("Unique identifier for the Site."), component_id: z .string() .describe("Unique identifier for the Component."), localeId: z .string() .optional() .describe( "Unique identifier for a specific locale. Applicable when using localization." ), 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." ), }), - src/tools/components.ts:145-193 (registration)The server.registerTool call that registers the 'components_get_properties' tool with its schema and handler function.
server.registerTool( "components_get_properties", { title: "Get Component Properties", description: "Get component properties including default values and configuration for a specific component.", inputSchema: z.object({ site_id: z.string().describe("Unique identifier for the Site."), component_id: z .string() .describe("Unique identifier for the Component."), localeId: z .string() .optional() .describe( "Unique identifier for a specific locale. Applicable when using localization." ), 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, component_id, localeId, limit, offset }) => { try { const response = await getClient().components.getProperties( site_id, component_id, { localeId, limit, offset, }, requestOptions ); return formatResponse(response); } catch (error) { return formatErrorResponse(error); } } );