get_parameter_schema

Class method that returns metadata about all parameters the skill accepts. Subclasses should call super().get_parameter_schema() and merge their own parameters.

Returns

dict[str, dict[str, Any]] — Parameter schema where keys are parameter names and values describe the parameter.

Built-in parameters:

Parameter	Type	Default	Description
`swaig_fields`	object	`{}`	Additional SWAIG metadata merged into tool definitions
`skip_prompt`	bool	`False`	Suppress default prompt section injection
`tool_name`	str	`SKILL_NAME`	Custom name for this instance (multi-instance skills only)

Schema value fields:

Field	Type	Description
`type`	str	`"string"`, `"integer"`, `"number"`, `"boolean"`, `"object"`, `"array"`
`description`	str	Human-readable description
`default`	Any	Default value
`required`	bool	Whether the parameter is required
`hidden`	bool	Hide in UIs (for secrets like API keys)
`env_var`	str	Environment variable that can provide this value
`enum`	list	Allowed values
`min` / `max`	number	Bounds for numeric types

Example

1 from signalwire.core.skill_base import SkillBase
2 
3 class WeatherSkill(SkillBase):
4     SKILL_NAME = "weather"
5     SKILL_DESCRIPTION = "Provides weather information"
6 
7     @classmethod
8     def get_parameter_schema(cls):
9         schema = super().get_parameter_schema()
10         schema.update({
11             "units": {
12                 "type": "string",
13                 "description": "Temperature units",
14                 "default": "fahrenheit",
15                 "enum": ["fahrenheit", "celsius"]
16             },
17             "api_key": {
18                 "type": "string",
19                 "description": "Weather API key",
20                 "required": True,
21                 "hidden": True,
22                 "env_var": "WEATHER_API_KEY"
23             }
24         })
25         return schema
26 
27     def setup(self) -> bool:
28         return True
29 
30     def register_tools(self):
31         pass
32 
33 # Inspect the schema
34 print(WeatherSkill.get_parameter_schema())
35 # {'swaig_fields': {...}, 'skip_prompt': {...}, 'units': {...}, 'api_key': {...}}