fetch_dashboard_framework_controls
Retrieve detailed control-level data for a specific Common Control Framework and review period. Returns assignment status, compliance state, due dates, scores, and priority levels with pagination support.
Instructions
Function Overview: Retrieve Control Details for a Given CCF and Review Period
This function retrieves detailed control-level data for a specified Common Control Framework (CCF) during a specific review period.
Args:
review_period: The compliance period (typically a quarter) for which the control-level data is requested.
Format:"Q1 2024"framework_name:
The name of the Common Control Framework to fetch data for.
Purpose
This function is used to fetch a list of controls and their associated data for a specific CCF and review period.
It does not return an aggregated overview — instead, it retrieves detailed, item-level data for each control via an API call.
The results are displayed in the MCP host with client-side pagination, allowing users to navigate through the control list efficiently without making repeated API calls.
Returns: - controls (List[FramworkControlVO]): A list of framework controls. - name (str): Name of the control. - assignedTo (str): Email ID of the user the control is assigned to. - assignmentStatus (str): Status of the control assignment. - complianceStatus (str): Compliance status of the control. - dueDate (str): Due date for completing the control. - score (float): Score assigned to the control. - priority (str): Priority level of the control. - page (int): Current page number in the overall result set. - totalPage (int): Total number of pages. - totalItems (int): Total number of items. - error (Optional[str]): An error message if any issues occurred during retrieval.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | Yes | ||
| framework_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| controls | No | ||
| page | No | ||
| totalPage | No | ||
| totalItems | No | ||
| error | No |