For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/core/interfaces/ToolSpec.md.
Lynx
  • English
  • Interface: ToolSpec

    Tool schema for prompt generation — describes a tool the LLM can use via Query()/Mutation(). Shape inspired by MCP's tool schema (name, description, inputSchema, annotations).

    Properties

    annotations?

    optional annotations?: object

    destructiveHint?

    optional destructiveHint?: boolean

    readOnlyHint?

    optional readOnlyHint?: boolean


    description?

    optional description?: string


    inputSchema

    inputSchema: Record<string, unknown>


    name

    name: string


    outputSchema

    outputSchema: Record<string, unknown>

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.