bridgable_query
Search OpenBridge component documentation via RAG.
bridgable_query
Search OpenBridge component documentation. This is the primary tool — your agent calls it whenever it needs to know about a component's props, events, slots, methods, or CSS parts.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search text, e.g. "slider value event", "obc-top-bar breadcrumbs". Prefer exact kebab-case tag names when the component is known. |
framework | string | No | Restrict results to a specific framework's wrappers: lit, react, vue, svelte, or angular. |
Returns
JSON-formatted search results with component names, sections, modules, relevance scores, and text snippets.
Usage notes
- Prefer exact component names —
obc-sliderreturns better results thanslider component. - Pass
frameworkwhen the user has already specified one. This keeps results aligned with the wrapper they're actually using. - Results include TypeScript enum member names, not HTML attribute values. See Enum props below.
Enum props
bridgable_query returns the TypeScript enum member name, not the string
value the HTML attribute expects. They often diverge:
| Component | Member name (in docs) | Actual attribute value |
|---|---|---|
obc-toggle-button-option type | iconText | text-icon |
Many variant props | inCommand | in-command |
When a prop's type looks like a TS enum (capitalized name, camelCase tokens), either:
- Check the component's
dist/<path>/<file>.jssource for the literal string values. - Use the framework wrapper and pass the value as a typed prop — TypeScript will narrow it to the correct string.
Never copy a CamelCase enum member straight into an HTML attribute.
Example
Your agent might call:
bridgable_query("obc-alert-menu-item props events", framework="react")And receive structured JSON with the component's full API surface.