Update tool

updateTool(projectReference: String!, id: String!, input: UpdateToolInput!): ToolSource!

Requires project.agents.write.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!Yes
idString!YesThe id of the definition, from its list.
inputUpdateToolInput!Yes

Input fields

input

UpdateToolInput

FieldTypeRequiredDescription
descriptionStringNoReplaces the description; omit it or send null to clear it.
sourceTargetKindWriteTargetKindNoThe source to write; default project.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

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

FieldTypeDescription
idID!
nameString!
descriptionString
sourcePathString!
sourceString!The source text of the tool file.
editModeSourceEditMode!
sourceOnlyReasons[String!]!Why the tool can only be edited as source; empty for a structured tool.

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

Example

graphql
mutation UpdateTool($projectReference: String!, $id: String!, $input: UpdateToolInput!) {
  updateTool(projectReference: $projectReference, id: $id, input: $input) {
    id
    name
    description
    editMode
    source
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "id": "example",
  "input": {}
}