Tool: get_logical_product
Retrieves details of a specific LogicalProduct, which is a standalone, customer-facing product within a Product Suite. This tool should be invoked when you need to fetch information about a specific logical product, using its unique name in the format of logicalProducts/{logical_product_id}.
The following code sample shows how to use curl to call the get_logical_product MCP tool.
| Curl Request |
|---|
curl --location 'https://cloudproductregistry.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_logical_product", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request message for GetLogicalProduct.
GetLogicalProductRequest
| JSON representation |
|---|
{ "name": string } |
| Fields | |
|---|---|
name |
Required. The name of the LogicalProduct to retrieve. Format: logicalProducts/{logical_product} |
Output Schema
Represents an independent service offering that can be provisioned by a customer.
LogicalProduct
| JSON representation |
|---|
{
"name": string,
"title": string,
"productSuite": string,
"variants": [
string
],
"lifecycleState": enum ( |
| Fields | |
|---|---|
name |
Identifier. The resource name of the LogicalProduct. Format: logicalProducts/{logical_product}. |
title |
Display name of the LogicalProduct. |
productSuite |
Product suite associated with the logical product. Format: productSuites/{product_suite}. |
variants[] |
Output only. Child variant resource references. Format: logicalProducts/{logical_product}/variants/{variant} |
lifecycleState |
Output only. Current Lifecycle state of the logical product. |
replaced |
Output only. Indicates whether the logical product has been replaced. If |
replacement |
Output only. The resource name of the Logical Entity that the logical product is replaced by. This field is only populated when this logical product is replaced by some other type. Eg: logicalProducts/{logical_product}/variants/{variant}, productSuites/{product_suite}, etc. |
LifecycleState
Enum representing the lifecycle state of the underlying entity.
| Enums | |
|---|---|
LIFECYCLE_STATE_UNSPECIFIED |
The default value. This value is used if the lifecycle state is not set. |
LIFECYCLE_STATE_PUBLIC_PREVIEW |
The entity is in Public Preview. It is available to all customers, but may not be feature-complete or have full support guarantees. |
LIFECYCLE_STATE_PRIVATE_GA |
Deprecated: Private General Availability entities are not exposed. The entity is in Private General Availability. It is fully supported and stable, but only available to a select group of customers. |
LIFECYCLE_STATE_GA |
The entity is Generally Available. It is fully supported, stable, and available to all customers. |
LIFECYCLE_STATE_DEPRECATED |
The entity is deprecated. It is no longer recommended for use and may be removed in a future version. |
Tool Annotations
Tool annotations are sent to MCP clients to describe the basic risk of a given tool. Most clients treat these hints as untrusted, but they can be used to decide when a confirmation prompt might be sent to a user.
Along with the title string, the following boolean hints are defined as follows:
readOnlyHint: If true, the tool doesn't modify its environment. Default: false.destructiveHint: If true, then the tool can perform destructive actions. If false, then the tool can only perform additive actions. Default: true.idempotentHint: If true, then calling the tool repeatedly with the same arguments will have no additional effect on its environment. Default: false.openWorldHint: If true, then the tool can interact with an 'open world' of external entities. If false, then the tool can only interact with internal entities. For example, a web search tool would be open world, while a memory tool would not be open world.
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌