get_risk_assessment_scorecard
Retrieve risk assessment scorecards to evaluate forecasting safety concerns and justify warnings about prediction implications. Use session IDs to access markdown or JSON formatted reports.
Instructions
A tool that retrieves the risk assessment scorecard for the Chronulus Session in Markdown format
When to use this tool:
Use this tool when the use asks about the risk level or safety concerns of a forecasting use case
You may also use this tool to provide justification to a user if you would like to warn them of the implications of what they are asking you to forecasting or predict.
How to use this tool:
Make sure you have a session_id for the forecasting or prediction use case
When displaying the scorecard markdown for the user, you should use an MDX-style React component
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| session_id | Yes | The session_id for the forecasting or prediction use case | |
| as_json | Yes | If true, returns the scorecard in JSON format, otherwise returns a markdown formatted scorecard |
Implementation Reference
- src/chronulus_mcp/session.py:45-65 (handler)The handler function that implements the core logic of the 'get_risk_assessment_scorecard' tool. It loads a Chronulus session using the provided session_id, generates the risk scorecard either as markdown or JSON based on the 'as_json' flag, and returns the content.async def get_risk_assessment_scorecard( session_id: Annotated[str, Field(description="The session_id for the forecasting or prediction use case")], as_json: Annotated[bool, Field(description="If true, returns the scorecard in JSON format, otherwise returns a markdown formatted scorecard")] ) -> str: """Get the risk assessment scorecard for the Session Args: session_id (str): The session_id for the forecasting or prediction use case. as_json (bool): If true, returns the scorecard in JSON format, otherwise returns a markdown formatted scorecard Returns: str: a risk assessment scorecard in the specified format. """ chronulus_session = Session.load_from_saved_session(session_id=session_id, verbose=False) scorecard_md = chronulus_session.risk_scorecard(width='100%') if as_json: content = json.dumps(chronulus_session.scorecard.model_dump()) else: content = scorecard_md return content
- src/chronulus_mcp/__init__.py:269-269 (registration)Registers the 'get_risk_assessment_scorecard' tool with the FastMCP server instance, associating it with a detailed usage description.mcp.add_tool(get_risk_assessment_scorecard, description=GET_RISK_ASSESSMENT_SCORECARD_DESCRIPTION)
- Defines the detailed description string used for the tool's schema/documentation, outlining when and how to use the tool, including input requirements like session_id.GET_RISK_ASSESSMENT_SCORECARD_DESCRIPTION = """ A tool that retrieves the risk assessment scorecard for the Chronulus Session in Markdown format When to use this tool: - Use this tool when the use asks about the risk level or safety concerns of a forecasting use case - You may also use this tool to provide justification to a user if you would like to warn them of the implications of what they are asking you to forecasting or predict. How to use this tool: - Make sure you have a session_id for the forecasting or prediction use case - When displaying the scorecard markdown for the user, you should use an MDX-style React component """
- src/chronulus_mcp/__init__.py:8-8 (registration)Imports the 'get_risk_assessment_scorecard' function from the session module, making it available for registration.from .session import create_chronulus_session, get_risk_assessment_scorecard