Repository navigation
Conversation
…acts Expands the Server Response Format section of the Function tools page with the scenarios customers repeatedly hit but the page omitted: returning an error (with the HTTP 200 rule), responding to multiple parallel tool calls with per-item toolCallId mapping, and a note that the response shape depends on the tool type. Cross-links the Troubleshoot tools guide.
…acts Expands the Server Response Format section of the Function tools page with the scenarios customers repeatedly hit but the page omitted: returning an error (with the HTTP 200 rule), responding to multiple parallel tool calls with per-item toolCallId mapping, and a note that the response shape depends on the tool type. Cross-links the Troubleshoot tools guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Expands the Server Response Format section of the Function tools page (
fern/tools/custom-tools.mdx) to cover the server-response scenarios customers repeatedly get stuck on but the page didn't document. Today the page shows only a single successfulresultsresponse, so builders hit a wall on errors, parallel calls, and non-function tool types.Gap type: Incomplete content (with a discoverability angle — the info exists on the Troubleshoot tools page, but builders never reach it from the main authoring page).
What changed
Three new subsections after the success example:
errorfield + the must-return-HTTP-200 rule + single-line-string requirement.toolCallIdmapping for paralleltoolCallListrequests, with independent success/error per call.resultsshape is the Function-tool contract and other server-backed types differ, plus a maintainer TODO to add a per-tool-type response table.All new content is grounded in existing Vapi docs (the Troubleshoot tools page) and cross-links to it.
Evidence (last ~4 weeks, customer-facing feedback)
tool_calls/ request states.Notes for reviewers
mainso the diff shows only the added subsections.{/* TODO(maintainers) */}marks where a per-tool-type response-shape table (Function vs Query/Knowledge Base vs Custom TTS/Transcriber) would fully close the gap — left for the team to confirm exact shapes.