Skip to main content

​
get_mode

Retrieves detailed information about a specific mode within a tokenset.

​
Tool Schema

{
  "name": "get_mode",
  "description": "Get a specific mode by ID",
  "inputSchema": {
    "type": "object",
    "properties": {
      "tokenset_id": {
        "type": "string",
        "description": "The ID of the tokenset"
      },
      "mode_id": {
        "type": "string",
        "description": "The ID of the mode to retrieve"
      }
    },
    "required": ["tokenset_id", "mode_id"]
  }
}

​
Parameters

ParameterTypeRequiredDescription
tokenset_idstringYesThe ID of the tokenset containing the mode
mode_idstringYesThe ID of the mode to retrieve

​
Response

{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "name": "Light",
  "is_default": true,
  "tokenset_id": "550e8400-e29b-41d4-a716-446655440010",
  "created_at": "2025-01-15T12:00:00Z",
  "updated_at": "2025-01-15T12:00:00Z"
}

​
Example Usage in Claude

​
Get Mode Details

You: Get details for mode 550e8400-e29b-41d4-a716-446655440020 in tokenset 550e8400-e29b-41d4-a716-446655440010

Claude: Here are the details for that mode:

**Mode: Light**
- **ID**: 550e8400-e29b-41d4-a716-446655440020
- **Default**: Yes ✓
- **Tokenset**: 550e8400-e29b-41d4-a716-446655440010
- **Created**: January 15, 2025 at 12:00 PM
- **Updated**: January 15, 2025 at 12:00 PM

​
Check if Mode is Default

You: Is the Dark mode the default in my color tokenset?

Claude: Let me check the Dark mode details.

The Dark mode (ID: 550e8400-e29b-41d4-a716-446655440021) is **not** the default mode.
The default mode is Light.

​
Common Use Cases

​
1. Mode Verification

You: Confirm the details of my Light mode

​
2. Default Status Check

You: Is this mode set as default?

​
3. Mode Information

You: When was this mode created?

​
Error Handling

If the mode doesn’t exist, you’ll get an error response. Make sure both tokenset_id and mode_id are valid.

​
Notes

  • Use this tool when you need specific information about a mode
  • The is_default flag indicates if this mode is used when no specific mode is requested
  • Mode IDs are unique within a tokenset but can be similar across different tokensets

​
See Also