Read skill source

skillSource(projectReference: String!, id: String!, sourceTargetKind: SourceReadTargetKind, runtimeTargetKind: RuntimeTargetKind, targetBranchId: ID, targetEnvironmentId: ID): SkillSource!

Requires project.agents.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!Yes
idString!YesThe id of the definition, from its list.
sourceTargetKindSourceReadTargetKindNoThe source to read; default runtimeTargetKind, else project. main_branch reads the project source.
runtimeTargetKindRuntimeTargetKindNoUsed as the source to read when sourceTargetKind is omitted.
targetBranchIdIDNoRequired with the kind preview_branch.
targetEnvironmentIdIDNoNot supported for source reads; a non-null value is refused as invalid_input.

Response

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

FieldTypeDescription
idID!
nameString!
descriptionString!
sourcePathString!
editModeSourceEditMode!
allowedTools[String!]!
instructionsString!The Markdown body of SKILL.md, excluding frontmatter.
sectionsStringMap!Read-only sections derived from the level-two headings of the body; empty when the body cannot be split.

All fields of SkillSource.

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

Example

graphql
query SkillSource($projectReference: String!, $id: String!, $sourceTargetKind: SourceReadTargetKind, $runtimeTargetKind: RuntimeTargetKind, $targetBranchId: ID, $targetEnvironmentId: ID) {
  skillSource(projectReference: $projectReference, id: $id, sourceTargetKind: $sourceTargetKind, runtimeTargetKind: $runtimeTargetKind, targetBranchId: $targetBranchId, targetEnvironmentId: $targetEnvironmentId) {
    id
    name
    allowedTools
    description
    editMode
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "id": "example"
}