QVeris
文档目录

ToolInfo

Information about a tool returned from search results. Contains everything needed to understand and execute the tool.

属性

as_of_support?

optional as_of_support?: boolean

Whether the capability supports point-in-time requests.

billing_rule?

optional billing_rule?: BillingRule

Structured rule-level billing metadata when available

body_params?

optional body_params?: JsonValue

calls_count?

optional calls_count?: string

capabilities?

optional capabilities?: ToolCapability[]

Standardized capability descriptors with coverage tags

capability?

optional capability?: string

Compact capability label returned by the routing projection.

categories?

optional categories?: (string | ToolCategory)[]

Tool categories/tags: category objects, or plain strings in legacy responses

category?

optional category?: string

cost?

optional cost?: string | number

cost_class?

optional cost_class?: string

Compact cost class returned by the routing projection.

description?

optional description?: string

Detailed description of what the tool does

docs_url?

optional docs_url?: string

Documentation URL for the tool

examples?

optional examples?: ToolExamples

Usage examples with sample parameters

execution_restrictions

execution_restrictions: ExecutionRestrictions

Eligibility, policy, and execution-readiness restrictions.

expected_cost?

optional expected_cost?: string | number

Pre-call cost estimate in credits, when available

final_score?

optional final_score?: number

Relevance score for the search query (0.0 - 1.0, higher = better match)

has_last_execution?

optional has_last_execution?: boolean

Whether this tool has execution history; not a guarantee of correctness or reliability

input_schema?

optional input_schema?: JsonValue

last_execution_record?

optional last_execution_record?: Record<string, unknown>

Most recent execution record, if available

name?

optional name?: string

Human-readable display name

output_schema?

optional output_schema?: JsonValue

parameters?

optional parameters?: JsonValue

parameters_schema?

optional parameters_schema?: JsonValue

params?

optional params?: ToolParameterContract

Provider parameter contract preserved exactly as JSON.

protocol?

optional protocol?: string

Protocol type

provider_description?

optional provider_description?: string

Description of the provider

provider_id?

optional provider_id?: string

Provider identifier

provider_name?

optional provider_name?: string | Record<string, string>

Name of the organization/service providing this tool

provider_website_url?

optional provider_website_url?: string

Provider website URL

query_params?

optional query_params?: JsonValue

region?

optional region?: string

Geographic availability of the tool.

  • "global" - Available worldwide
  • "US|CA" - Whitelist: only available in US and Canada
  • "-CN|RU" - Blacklist: not available in China and Russia

reliability?

optional reliability?: string

Compact reliability grade returned by the routing projection.

requestBody?

optional requestBody?: JsonValue

score?

optional score?: number

service_id?

optional service_id?: string

Stable public service identity when the backend can prove provider equivalence.

stats?

optional stats?: ToolStats

Historical execution performance statistics

tool_id

tool_id: string

Unique identifier for the tool (used in call)

tool_name?

optional tool_name?: string

verification

verification: CatalogVerification

Evidence supporting the verification state.

verification_status

verification_status: VerificationStatus

Fail-closed verification state for this catalog result.

optional why_recommended?: string

Human-readable explanation of why this tool was recommended (Discover results only)


这个页面对你有帮助吗?