get_custom_column_options
Retrieve custom columns and their options from Standard Metrics. Specify page and per-page parameters to paginate results.
Instructions
Get all custom columns and their available options.
Args: page: Page number for pagination (default: 1) per_page: Results per page (default: 100, max: 100)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| per_page | No |
Implementation Reference
- src/tools.py:207-219 (handler)The MCP tool handler function decorated with @mcp.tool that exposes 'get_custom_column_options'. Calls client.get_custom_column_options(page, page_size).
@mcp.tool async def get_custom_column_options( page: int = 1, per_page: int = 100, ) -> PaginatedCustomColumnOptions: """Get all custom columns and their available options. Args: page: Page number for pagination (default: 1) per_page: Results per page (default: 100, max: 100) """ async with StandardMetrics() as client: return await client.get_custom_column_options(page=page, page_size=per_page) - src/_client.py:219-228 (helper)Client-side implementation that makes the actual HTTP GET request to 'v1/custom-columns/options/' and validates the response into PaginatedCustomColumnOptions.
async def get_custom_column_options( self, *, page: int = 1, page_size: int = 100, ) -> PaginatedCustomColumnOptions: """Get all custom columns and their available options.""" params: dict[str, Any] = {"page": page, "page_size": page_size} response = await self._request("GET", "v1/custom-columns/options/", params=params) return PaginatedCustomColumnOptions.model_validate(response) - src/_types.py:177-182 (schema)Pydantic model representing a single custom column option with id, name, type, and optional list of options.
class CustomColumnOption(pydantic.BaseModel): id: str name: str type: str options: list[Option] | None = None - src/_types.py:279-279 (schema)Type alias for a paginated response containing CustomColumnOption items.
PaginatedCustomColumnOptions = PaginatedResponse[CustomColumnOption] - src/server.py:35-35 (registration)Documentation/listing of the tool in the server description; the actual registration is via the @mcp.tool decorator in src/tools.py.
- get_custom_column_options: Get available custom column definitions