Skip to content
AssureSwarm Docs

Agent Operating Guide

/coach-document-link

Attach an external document URL to a workflow step through human review, with a display name and an auto-detected file type.

Attach an external document URL, a Google Doc, SharePoint file, Confluence page, OneDrive link, or any web-accessible reference, to a workflow step so it sits alongside uploaded files in the step’s Documents list. The skill resolves the step, validates the URL is well-formed, derives a display name, and submits one suggestion via suggest_change: the link doesn’t appear until a human approves it. To upload the file’s bytes instead of linking a URL, use /coach-document-upload.

When to use

Section titled “When to use”

When you want to link, attach, or reference an external document on a step by its URL. For uploading a local file’s bytes rather than pointing at a hosted URL, use /coach-document-upload instead.

Inputs

Section titled “Inputs”
Flag Required Notes
--step-id <id> If not clear from context The step to attach the link to. Inferred from the current view if absent.
--url <url> Yes The external http(s) URL. Asked for if absent.
--file-name <text> No Display name for the link; derived from the URL and confirmed if absent.
--file-type <text> No A mimeType or short type label; auto-detected where obvious.
--reason <text> No One sentence for the suggestion’s reason.

Example

Section titled “Example”

/coach-document-link --step-id <id> --url https://docs.google.com/document/d/… validates the URL, detects the google-doc type, derives a display name (confirming it with you if it came from the URL path), and submits a create suggestion. You approve it in Canvas: the link shows on the step once you do.

Good to know

Section titled “Good to know”
  • It’s reviewed, unlike an upload. Because the link goes through suggest_change, the handoff is a review-and-approve link and nothing appears on the step until approval.
  • URL validation is shallow. The platform checks the http/https scheme and basic format only: it does not confirm the link is reachable or that the recipient has access. Sharing and permissions on the linked side are your responsibility.
  • The file type is auto-detected for Google Docs, Sheets, and Slides, and for .pdf or .docx URLs; otherwise it’s omitted, which the platform accepts.
  • Each link belongs to one step. There’s no share-across-steps primitive: link the URL to each step separately. Removing a link is a delete suggestion against the document’s id, which comes from a get_step_context response.
Section titled “Related”