Skip to content

Apply documentation edit pass - #1244

Merged
amanda-vapi merged 8 commits into
mainfrom
codex/documentation-edit-pass
Sep 24, 2026
Merged

Apply documentation edit pass#1244
amanda-vapi merged 8 commits into
mainfrom
codex/documentation-edit-pass

Conversation

@stephenvapiai

@stephenvapiai stephenvapiai commented Sep 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

  • Standardize Function tool response terminology
  • Clarify MCP and API Request tool recommendations
  • Update the legacy Make route to point to the new integration guide
  • Improve the Function tool request JSON example
  • Standardize example domains and phone numbers

Scope

This follow-up applies a focused documentation edit pass after #1243.

It intentionally leaves the Make page title and structure, the MCP client navigation label, fern/tools/mcp.mdx, and generated API schemas unchanged.

Validation

  • Parsed all 3 JSON examples in fern/tools/custom-tools.mdx
  • Parsed all 4 JSON examples in fern/tools/static-variables-and-aliases/static-parameters.mdx
  • Confirmed example values use a reserved example.com domain and +1 415 555-01xx phone numbers
  • Confirmed /tools/make redirects to the existing /tools/integrations/make route
  • Confirmed the MCP client navigation label remains unchanged
  • Ran git diff --check
  • Scanned the changed pages for hidden work material
  • Did not run local Fern checks

@lightsage-app

lightsage-app Bot commented Sep 22, 2026 •
edited
Loading

Copy link
Copy Markdown

Lightsage docs evals

Result: passed
Staging docs: https://vapi-preview-01a0d49e-c647-73e1-acb5-5db1cc13703a.docs.buildwithfern.com
Commit: 3a58730

Average score: 100/100
Passed: 3/3

Eval ID Status Score Model Tools Docs 404
08e24c18-82a0-45de-abdc-d237bd12bc0f Pass 100 claude-code/global.anthropic.claude... 18 0
08e24c18-82a0-45de-abdc-d237bd12bc0f Pass 100 cursor/auto 24 2
08e24c18-82a0-45de-abdc-d237bd12bc0f Pass 100 codex/gpt-5.4 27 1

@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0c9f3-fe99-72ce-a146-f879d3e3cb74.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0c9fc-888b-70e5-a3e6-f17015b94224.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0ca02-87a9-706c-ac5a-44c06f4a3fcb.docs.buildwithfern.com

amanda-vapi
amanda-vapi reviewed Sep 22, 2026
View reviewed changes
Comment thread fern/tools/integrations/make.mdx Resolved
stephenvapiai and others added 2 commits September 23, 2026 09:12
@stephenvapiai @amanda-vapi
Apply suggestion from @amanda-vapi
c9a55dd 
Co-authored-by: Amanda Martin <290842976+amanda-vapi@users.noreply.github.com>
@stephenvapiai
Merge branch 'main' into codex/documentation-edit-pass
588883d
@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0cf1f-b88d-738a-a22e-d4d164aa05dc.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0cf22-3e88-7573-9ebf-98313ccc098c.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0d485-e063-73c8-81ec-89e5399244a8.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0d49e-0cbb-73c3-9677-3418285eb0af.docs.buildwithfern.com

@github-actions

github-actions Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://vapi-preview-01a0d49e-c647-73e1-acb5-5db1cc13703a.docs.buildwithfern.com

@amanda-vapi
amanda-vapi merged commit 0aea604 into main Sep 24, 2026
6 checks passed
stephenvapiai added a commit to stephenvapiai/docs that referenced this pull request Sep 28, 2026
@stephenvapiai
docs(tools): document the error field for Function tool responses
6a8b66a 
Customers asking Ask AI and filing support tickets about custom/Function
tools repeatedly ask how to report a tool failure back to Vapi -- the
Server Response Format section only showed the success `result` shape.
The `error` field already exists and is used elsewhere (troubleshooting
guide, API-vs-Function comparison), but was never documented on the
primary Function tools guide where builders land first.

Adds the `error` field, its trigger semantics (presence of the field,
not its content, selects Request Failed), a failure example, and the
always-return-HTTP-200 rule, cross-linked to the troubleshooting guide.
Does not touch the Request Format section edited in VapiAI#1244 four days ago.
@stephenvapiai stephenvapiai mentioned this pull request Sep 28, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@amanda-vapi amanda-vapi amanda-vapi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@stephenvapiai @amanda-vapi