ClickUp MCP Integration

Instructions

Implementation Reference

• src/controllers/custom-field.controller.ts:24-30 (handler)

  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) }],
    };
  },

• src/controllers/custom-field.controller.ts:19-23 (schema)

  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,

• src/services/custom-field.service.ts:28-34 (helper)

  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`
    );
  }