Skip to content

Add tool execution to tool registry docs#296

Merged
UsamaAnser1518 merged 3 commits into
masterfrom
usama/tool-execution-docs
May 21, 2026
Merged

Add tool execution to tool registry docs#296
UsamaAnser1518 merged 3 commits into
masterfrom
usama/tool-execution-docs

Conversation

@UsamaAnser1518
Copy link
Copy Markdown
Contributor

Summary

PromptLayer can now run a tool's body in a sandbox between LLM turns, so your prompt completes end-to-end without your app writing a tool-call loop.

What's new

New feature page

  • features/tool-registry/auto-execution.mdx, headline conceptual doc covering the tool-call loop, how PromptLayer drives it, body writing conventions (args dict, body-only editor), supported languages, behaviour in prompts (single/multi/mixed tool calls + 10-iteration cap), errors split (user-code vs infra), sandbox security, and when to use vs not.

New reference pages

  • reference/tool-registry-create-version.mdxPOST /api/public/v2/tool-registry/{identifier}/versions
  • reference/tool-registry-test-execute.mdxPOST /api/public/v2/tool-registry/{identifier}/test-execute

What's updated

Feature pages

  • features/tool-registry/overview.mdx — added paragraph + link to the auto-execution page
  • features/tool-registry/using-in-prompts.mdx — added "Auto Execution" subsection

Reference pages

  • reference/tool-registry-create.mdx — note about the new optional execution payload
  • reference/tool-registry-get.mdx — note that response includes execution when present

OpenAPI spec (openapi.json)

  • New paths: POST /tool-registry/{identifier}/versions, POST /tool-registry/{identifier}/test-execute
  • POST /tool-registry — added optional description and execution to the body
  • GET /tool-registry — added description to each item's response
  • GET /tool-registry/{identifier} — added description to the registry, mention of execution on the version

Navigation (docs.json)

  • Added auto-execution to the Tool Registry feature group
  • Added tool-registry-create-version and tool-registry-test-execute to the Tool Registry reference group

New assets

  • images/tool-registry/test-run-dialog.png
  • images/tool-registry/execution-editor-py.png
  • images/tool-registry/execution-editor-js.png
  • images/tool-registry/execution-toggle.png

Incidental fix

  • docs.json — replaced deprecated add-mcp enum value in contextual.options with mcp (Mintlify removed add-mcp from the allowed list; was blocking mintlify dev).

Test plan

  • mintlify dev runs without errors
  • /features/tool-registry/auto-execution renders end-to-end, all 4 images visible with rounded corners, tabs (Python/JS) switch, code samples render
  • /reference/tool-registry-create-version and /reference/tool-registry-test-execute render with auto-generated request/response panels
  • Sidebar shows the new entries under Tool Registry (feature + reference groups)
  • Cross-page links to /features/tool-registry/auto-execution from overview, using-in-prompts, create, get, create-version, test-execute all resolve
  • Unrelated pages (e.g. /reference/templates-get, other feature groups) still render — confirms openapi.json + docs.json weren't broken

@UsamaAnser1518 UsamaAnser1518 requested review from bb220 and hasaan21 May 18, 2026 16:36
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 18, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
promptlayer 🟢 Ready View Preview May 18, 2026, 4:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread openapi.json Outdated
Comment thread openapi.json Outdated
@UsamaAnser1518 UsamaAnser1518 merged commit 100d707 into master May 21, 2026
4 checks passed
@UsamaAnser1518 UsamaAnser1518 deleted the usama/tool-execution-docs branch May 21, 2026 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants