list_compensations
Retrieve compensation records including salary and bonus. Filter by person ID or compensation type ID.
Instructions
List compensation records (salary, bonus, etc.). Optional filters: personId, typeId.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| person_id | No | ||
| type_id | No | ||
| limit | No | ||
| skip | No |
Implementation Reference
- humaans_mcp/server.py:289-302 (handler)The `list_compensations` tool handler. It is decorated with `@mcp.tool()` and accepts optional filters `person_id`, `type_id`, `limit`, and `skip`. It delegates to `HumaansClient.list_page()` on the `/compensations` endpoint.
@mcp.tool() async def list_compensations( person_id: str | None = None, type_id: str | None = None, limit: int = 100, skip: int = 0, ) -> Any: """List compensation records (salary, bonus, etc.). Optional filters: personId, typeId.""" return await client().list_page( "/compensations", filters={"personId": person_id, "typeId": type_id}, limit=limit, skip=skip, ) - humaans_mcp/server.py:289-290 (registration)The `@mcp.tool()` decorator registers `list_compensations` as an MCP tool in the FastMCP server instance.
@mcp.tool() async def list_compensations( - humaans_mcp/client.py:45-55 (helper)The `HumaansClient.list_page()` helper method that `list_compensations` calls. It sends a GET request with `$limit`/`$skip` pagination and optional filters as query parameters.
async def list_page( self, path: str, filters: dict[str, Any] | None = None, limit: int = 100, skip: int = 0, ) -> Any: params = dict(filters or {}) params["$limit"] = limit params["$skip"] = skip return await self.get(path, params)