Add Docs for AI Agents page documenting machine-readable documentation - #175
Open
tylergoerzen-mxp with Copilot wants to merge 4 commits into
Open
Add Docs for AI Agents page documenting machine-readable documentation#175tylergoerzen-mxp with Copilot wants to merge 4 commits into
tylergoerzen-mxp with Copilot wants to merge 4 commits into
Conversation
Co-authored-by: tylergoerzen-mxp <259741734+tylergoerzen-mxp@users.noreply.github.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Copilot
AI
changed the title
[WIP] Add docs-for-AI-agents page documenting machine-readable surfaces
Add Docs for AI Agents page documenting machine-readable documentation
Aug 18, 2026
Contributor
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| docs/docs-for-ai-agents.mdx | Adds the machine-readable documentation guide and resolves the previously reported metadata, negotiation, surface-discovery, and OpenAPI-path issues. |
| docs.json | Adds the new page to the MIXPANEL AI navigation group. |
Reviews (4): Last reviewed commit: "Document Accept: text/markdown content n..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
tylergoerzen-mxp
approved these changes
Aug 18, 2026
The page pointed at /openapi/ingestion.yaml and /openapi/query.yaml. Both serve today but neither is tracked in git; the real files are *.openapi.yaml. Those two URLs are stale deploy artifacts that break on the next prune. Replace them with all 13 tracked specs, each verified 200. Add the three capabilities the page omitted: - per-page Markdown (append .md to any docs URL) - the documentation MCP server at docs.mixpanel.com/mcp, which is distinct from the Mixpanel MCP server at /docs/mcp that the page previously called just "the MCP server" - the contextual copy/open menu already enabled in docs.json Correct two claims: llms.txt indexes all 458 pages rather than a curated subset, and llms-full.txt is 3.5 MB, so the page no longer suggests pasting it into a system prompt. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The page covered the .md suffix but not the header path, so readers fetching canonical URLs had no way to discover they can request Markdown without rewriting the URL. Verified: Accept: text/markdown returns text/markdown and the body is byte-identical to the .md variant. Without the header the same URL returns text/html. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
tiffanyqi
approved these changes
Aug 19, 2026
|
|
||
| | Page | Markdown | | ||
| | --- | --- | | ||
| | [docs.mixpanel.com/docs/quickstart](https://docs.mixpanel.com/docs/quickstart) | [docs.mixpanel.com/docs/quickstart.md](https://docs.mixpanel.com/docs/quickstart.md) | |
Contributor
There was a problem hiding this comment.
nit: you can convert all of these to remove the "https://docs.mixpanel.com" so that it can be locally sourced
example: [docs.mixpanel.com/docs/quickstart](/docs/quickstart)
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.
Adds a new docs page surfacing the machine-readable documentation formats Mixpanel exposes —
llms.txt,llms-full.txt, and OpenAPI specs — so AI agents and LLM tooling have a documented entry point for consuming Mixpanel docs programmatically.Changes
docs/docs-for-ai-agents.mdx— New page covering:llms.txt(concise index, llmstxt.org standard) andllms-full.txt(full content dump) endpointsdocs.json— Addsdocs/docs-for-ai-agentsto the MIXPANEL AI navigation group alongside MCP, Headless, and related AI pages