Get comprehensive API documentation for a UI5 Web Components React component including props, ref methods, types, event detail parameters, and CSS parts for shadow DOM styling. WHEN TO USE: You need exact prop names, types, default values, method signatures, event detail fields, or CSS part selec...
AI agents call get_component_api to retrieve information from Webcomponents React without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
componentName | string | Yes | Component name (e.g., "Button", "AnalyticalTable"). Case-insensitive. Must match a component from @ui5/webcomponents-react, @ui5/webcomponents-react-charts, or |
Parameters from the server's own tool schema.
This tool performs read-only queries against a documentation system. It fetches and returns data (component API specifications) without creating, modifying, executing, or deleting anything. The severity is low because misuse simply returns potentially irrelevant documentation rather than causing harm to systems or data.
From the tool's definition Tool retrieves "comprehensive API documentation" including "props, ref methods, types, event detail parameters, and CSS parts" for UI5 Web Components.
Documented attack patterns abuse exactly the kind of access get_component_api gives an agent:
PolicyLayer is an MCP gateway — it sits between your AI agents and Webcomponents React, and nothing reaches the server without passing your rules. This is the rule we recommend for get_component_api:
{
"version": "1",
"default": "deny",
"tools": {
"get_component_api": {}
}
}get_component_api is read-only, so it stays allowed — but everything else on the server is denied unless you say otherwise.
Free to start. No card required.
Get comprehensive API documentation for a UI5 Web Components React component including props, ref methods, types, event detail parameters, and CSS parts for shadow DOM styling. WHEN TO USE: You need exact prop names, types, default values, method signatures, event detail fields, or CSS part selectors for a specific component. DO NOT USE FOR: General guidance on styling, events, or architecture — use get_documentation instead. To discover component names — use list_components first. WORKFLOW: Use list_components to find the correct component name, then this tool for full API details. LIMITS: Returns data for one component per call. Returns all props and methods for that component. EXAMPLE INPUT: { "componentName": "Dialog" } Output Format (JSON): typescript { package: string, // NPM package name description: string, // Full JSDoc description with @tags, examples, notes props: { [propName: string]: { type: { name: string, // Type category (e.g., "string", "boolean", "enum") raw?: string, // Full TypeScript type string value?: Array<{ // For enums: possible values with descriptions value: string, description?: string }> }, required: boolean, // Whether prop is required defaultValue: any, // Default value if specified description: string, // Full prop description with notes eventDetail?: { // Present on event handler props (web components only) params: Array<{ // Fields available on e.detail name: string, // e.g., "targetRef", "escPressed", "item" type: string, // e.g., "HTMLElement", "boolean" description: string // What this detail field contains }>, cancelable: boolean, // true = e.preventDefault() prevents the action bubbles: boolean // true = event bubbles through DOM } } }, methods: Array<{ // Imperative handle methods (access via ref.current.methodName()) name: string, description: string, params: Array<{ name: string, description: string, type: any }>, returns: any }>, cssParts?: Array<{ // CSS ::part() selectors for shadow DOM styling (web components only) name: string, // Use as: componentSelector::part(name) { ... } description: string }>, subTypeDocs?: string // Markdown docs for complex prop types (e.g. column definition properties) docUrl?: string // Upstream docs link for complex behavioral concepts } Note: Generic HTML attributes (className, style, onClick, etc.) are filtered out but available via CommonProps. Ref methods are accessed via componentRef.current.methodName(). Event detail fields (eventDetail.params) tell you what's on e.detail — access via e.detail.paramName. It is categorised as a Read tool in the Webcomponents React MCP Server, which means it retrieves data without modifying state.
get_component_api accepts 1 parameter: componentName. Required: componentName. The full parameter table on this page comes from the server's own tool schema.
Register the Webcomponents React MCP server in PolicyLayer and add a rule for get_component_api: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Webcomponents React. Nothing to install.
get_component_api is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the get_component_api rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for get_component_api. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
get_component_api is provided by the Webcomponents React MCP server (@ui5/webcomponents-react-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
Start from Webcomponents React, add the rest of your stack, and see everything your agents can call. Then put policy on all of it.
Free to start. No card required.
5 Webcomponents React tools catalogued and risk-classified — across an index of 43,000+ MCP servers.