pn_get
Retrieve complete documentation and parameter details for a specific Panel component. Use when you need full information including docstring and initialization signature.
Instructions
Get complete details about a single Panel component including docstring and parameters.
Use this tool when you need full information about a specific Panel component, including its docstring, parameter specifications, and initialization signature.
Tip: If you only need parameter details and already know the component exists, use params instead for a lighter response without the docstring.
IMPORTANT: This tool returns exactly one component. If your criteria match multiple components, you'll get an error asking you to be more specific.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Component name to match (case-insensitive). If None, must specify other criteria. Examples: "Button", "TextInput", "Slider" | |
| module_path | No | Full module path to match. If None, uses name and package to find component. Examples: "panel.widgets.Button", "panel_material_ui.Button" | |
| package | No | Package name to filter by. If None, searches all packages. Examples: "panel" or "panel_material_ui" |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| module_path | Yes | Full module path of the component, e.g., 'panel.widgets.Button' or 'panel_material_ui.Button'. | |
| name | Yes | Name of the component, e.g., 'Button' or 'TextInput'. | |
| package | Yes | Package name of the component, e.g., 'panel' or 'panel_material_ui'. | |
| description | Yes | Short description of the component's purpose and functionality. | |
| init_signature | Yes | Signature of the component's __init__ method. | |
| docstring | Yes | Docstring of the component, providing detailed information about its usage. | |
| parameters | Yes | Dictionary of parameters for the component, where keys are parameter names and values are ParameterInfo objects. |