Agents / TypeScript SDK

Read skill

Read the full playbook body of one Pipeline-owned first-party workspace skill by name. Returns its metadata, availability, version, and raw markdown content. Use this to inspect the skill before hosted execution or an external work-order claim. Read-only.

pipeline.readSkillDeterministic operation

Parameters

workspaceIdOptional · string
Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
skillNameRequired · string
The skill name from frontmatter (e.g. dream-one-hundred, cold-email-write).
Request example
await pipeline.readSkill({
  "skillName": "example"
})
Full input schema
Input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "skillName": {
      "type": "string",
      "description": "The skill name from frontmatter (e.g. dream-one-hundred, cold-email-write)."
    }
  },
  "required": [
    "skillName"
  ]
}
See this operation inCLI MCP REST API
TypeScript SDK | Pipeline v2 preview