yade_query_api
Search YADE Python API documentation by keywords to find classes and functions when exact names are unknown. Returns ranked matches with descriptions.
Instructions
Search YADE API documentation by keywords (like grep).
Returns matching class/function names with descriptions ranked by relevance. Use yade_browse_api for full documentation of a specific class.
When to use:
You have keywords but don't know the exact class name
Examples: "friction material", "gravity engine", "contact force", "triaxial stress", "sphere create", "hertz mindlin"
Related tools:
yade_browse_api: Get full documentation for a known class path
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search keywords for YADE Python API. Examples: 'sphere body', 'triaxial compression', 'contact force'. Case-insensitive. | |
| limit | No | Maximum number of results (1-20). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||