clickup_get_list_custom_fields
Retrieve custom fields for a ClickUp list to access structured task data and metadata for workflow automation.
Instructions
Get all accessible custom fields for a list
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list_id | Yes | ClickUp list ID |
Implementation Reference
- The handler function for the 'clickup_get_list_custom_fields' tool. It extracts the list_id from input, calls the CustomFieldService to fetch custom fields, and returns the response as JSON text.handler: async (input) => { const { list_id } = input; const response = await customFieldService.getListCustomFields(list_id); return { content: [{ type: "text", text: JSON.stringify(response) }], }; },
- Input schema and metadata (name, description) for the 'clickup_get_list_custom_fields' tool, defining the required 'list_id' parameter.name: "clickup_get_list_custom_fields", description: "Get all accessible custom fields for a list", inputSchema: { list_id: z.string().describe("ClickUp list ID"), },
- src/index.ts:23-26 (registration)Import of the getListCustomFieldsTool from the custom-field controller.getListCustomFieldsTool, setCustomFieldValueTool, setCustomFieldValueByCustomIdTool, } from "./controllers/custom-field.controller";
- src/index.ts:48-48 (registration)Addition of getListCustomFieldsTool to the tools array for registration with the MCP server.getListCustomFieldsTool,
- Helper method in CustomFieldService that performs the API request to retrieve custom fields for the given list ID.async getListCustomFields( listId: string ): Promise<{ fields: ClickUpCustomField[] }> { return this.request<{ fields: ClickUpCustomField[] }>( `/list/${listId}/field` ); }