Get tool

tool(projectReference: String!, id: String!, sourceTargetKind: SourceTargetKind, runtimeTargetKind: RuntimeTargetKind, targetEnvironmentId: ID, targetBranchId: ID): Tool!

Requires project.agents.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!Yes
idString!YesThe id of the definition, from its list.
sourceTargetKindSourceTargetKindNoThe source to read; default runtimeTargetKind, else project.
runtimeTargetKindRuntimeTargetKindNoUsed as the source to read when sourceTargetKind is omitted.
targetEnvironmentIdIDNoRequired with the kind environment.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

Returns Tool!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
nameString!
descriptionString
sourcePathString!
editModeSourceEditMode!
inputSchemaJSONObjectThe JSON Schema of the tool input, when the tool declares one.
outputSchemaJSONObjectThe JSON Schema of the tool output, when the tool declares one.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Tool($projectReference: String!, $id: String!, $sourceTargetKind: SourceTargetKind, $runtimeTargetKind: RuntimeTargetKind, $targetEnvironmentId: ID, $targetBranchId: ID) {
  tool(projectReference: $projectReference, id: $id, sourceTargetKind: $sourceTargetKind, runtimeTargetKind: $runtimeTargetKind, targetEnvironmentId: $targetEnvironmentId, targetBranchId: $targetBranchId) {
    id
    name
    description
    editMode
    inputSchema
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "id": "example"
}