Guest Machines
API referenceCapabilities

Retrieve a tool

GET/api/v1/tools/{tool_name}

Retrieve one tool's complete public definition, including its risk and capability classifications, by its catalog name.

Required access

Credentials: service principal, delegated token, user session

A tool outside the caller-visible assignment catalog answers 404 rather than disclosing its definition.

Authorization

AuthorizationBearer <token>

An organization-owned automation key, prefixed gsmc_sk_. Already bound to one organization, so it needs no X-Org-Id header. It carries no user identity: it never reaches a private resource however it is scoped, and a run it starts has no user for an interactive tool to reach.

In: header

Path Parameters

tool_name*Tool Name

Header Parameters

X-Org-Id?|

Selects the active organization for a credential that belongs to more than one. Service-principal keys are bound to a single organization and ignore it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/tools/string" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
{  "origin": "builtin",  "source_id": "string",  "canonical_name": "string",  "display_name": "string",  "namespace": "string",  "summary": "string",  "management_mode": "agent_assignable",  "ui_visibility": "user_catalog",  "enabled": true,  "owned_by_caller": true,  "description": "string",  "input_schema": {},  "output_schema": {},  "risk_level": "string",  "capabilities": [    "string"  ],  "usage_guide": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}