View as Markdown
Ironclad icon

Ironclad ACTION

Describe Workspace

Orients you to this Ironclad workspace: returns every configured record type and property (with its type), plus the first page of launchable workflow templates. This is the primary orienting call — run it first for any question about what record types, properties, or workflow templates exist in the workspace, before List Type Options / List Properties Options / List Template ID Options (those three exist only to resolve one value while configuring another tool's prop, not for general discovery — using them for discovery skips the bundled context this tool provides). Takes no parameters. If workflowTemplates looks capped at a page boundary, run List Template ID Options with an incremented page for the rest. Example return: {"recordTypes": {"vendor_agreement": "Vendor Agreement"}, "properties": {"contractValue": "monetary_amount", "counterpartyName": "string"}, "workflowTemplates": [{"id": "tmpl_abc123", "name": "NDA Template"}]}. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ironclad account once, then configure and run Describe Workspace from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ironclad-describe-workspace",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ironclad: { authProvisionId: "apn_xxxxxxx" },
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Describe Workspace inputs
Property Type Description

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ironclad-describe-workspace
Version
0.0.2
App
Ironclad
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes