Function tools: document error response format and async behavior - #1260
stephenvapiai wants to merge 1 commit into
Conversation
…nction tools The "Server Response Format" section only showed the success `result` shape and never documented the `error` field, and Step 4's Async Mode bullet had no explanation of `async: true` behavior. Adds the missing error response format, the request-complete vs request-failed trigger rule, an async-mode behavior explanation, and a cross-link to the existing Custom tools troubleshooting page. See PR description for the customer-feedback evidence.
Why this changeSignal: Over the trailing 28 days, What customers were actually asking (sampled from the unanswered conversations):
Content check: Classification: Incomplete content (missing error format + message-trigger semantics on the primary reference page), with a secondary discoverability fix (cross-link to the troubleshooting page that already has the detail). Fix in this PR:
No new page or nav change — this is a content-only edit to the existing page, scoped to the #1 ranked gap from this week's feedback pass. Ranking/runner-up detail intentionally omitted per the drafting workflow. |
Edits
fern/tools/custom-tools.mdx(Function tools) to add the missing tool-response error format, clarify async-mode behavior, and cross-link the existing troubleshooting page. Reasons and supporting customer-feedback evidence are in the PR comment below.