Add agent discovery directive and reference page#197
Add agent discovery directive and reference page#197jordanurbs wants to merge 1 commit intoveniceai:mainfrom
Conversation
Add agent-reference.html — a static, token-optimized single-page API reference for AI agents — and surface it across the docs: - agent-reference.html: complete API reference (static HTML, no framework overhead) - llms.txt: prepend AGENT NOTICE as first blockquote - docs.json: add dismissible banner, sidebar link with robot icon, agent meta tags - about-venice.mdx: add Note callout on landing page - ai-agents.mdx: add Agent API Reference section at top Made-with: Cursor
There was a problem hiding this comment.
Requesting changes for now. I agree with the goal of making the docs more agent-friendly, but I don’t think this implementation is ready to merge yet.
My main concern is that this introduces too many competing agent entrypoints instead of defining one clear canonical path. I also don’t think a dedicated agent-reference.html is the right long-term fix here, especially if it can drift from the actual docs/spec and create a second source of truth.
I found examples where the new agent-facing content already appears inconsistent with the current docs/spec. For example, it says image generation is not OpenAI-compatible even though we already document POST /images/generations as an OpenAI-compatible endpoint, and it also hard-codes model counts/recommendations and endpoint behavior that are likely to drift over time. I also saw method/behavior details in the page that made me nervous about pointing agents to it as a canonical reference.
Separately, I don’t think we should degrade the normal docs UX for this. The banner, visible note, sidebar link, and other user-facing agent promos feel like the wrong tradeoff.
I’d rather we step back and simplify the approach:
- define one canonical agent entrypoint
- keep agent discovery low-clutter for normal users
- rely on
llms.txtplus the existing docs/OpenAPI as source of truth - avoid adding a separate HTML artifact unless we’re committed to maintaining it as a first-class surface
Happy to revisit once the approach is tighter and the current inconsistencies are resolved.
+1'ing this. If Mintlify already has standard procedures for handling llms.txt and such, it can be inferred that agents will probably be expecting us to follow those procedures. Unrelated to this PR, but related to the core issue that we're solving here: we should probably figure out a way to render those model names in the |
Summary
agent-reference.html(new): Static, token-optimized single-page API reference for AI agents — every endpoint, model, code example, and pitfall in one file with zero framework overhead.docs.json: Add dismissible banner on every page, sidebar link (with robot icon) in the Overview group, andai-agent-referencemeta tags.llms.txt: PrependAGENT NOTICEblockquote directing agents todocs.venice.ai/agent-reference.html.about-venice.mdx: Add<Note>callout at the top of the landing page.ai-agents.mdx: Add "Agent API Reference" section at the top of the AI Agents guide.Why
AI agents scraping
docs.venice.aicurrently crawl dozens of Mintlify pages to piece together API knowledge. This PR adds a single static HTML page atdocs.venice.ai/agent-reference.htmland makes it discoverable through five layers:llms.txt— the standard that Cursor, Claude Code, LangChain, OpenClaw, etc. check firstTest plan
agent-reference.htmlloads atdocs.venice.ai/agent-reference.htmlas static HTML (no Mintlify wrapper)llms.txtshows the AGENT NOTICE blockquote before the existing description<Note>callout renders on/overview/about-venice/overview/guides/ai-agentsdocs.venice.ai/agent-reference.htmlMade with Cursor