Skip to content

Document Search API usage and client availability - #619

Draft
chruffins wants to merge 3 commits into
mainfrom
hypeship/search-api-docs
Draft

chruffins wants to merge 3 commits into
mainfrom
hypeship/search-api-docs

Conversation

@chruffins

@chruffins chruffins commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a Search guide with cURL, TypeScript, Python, and CLI examples, provider discovery, filters, and access requirements.
  • Add navigation and cross-links from CLI and MCP documentation search.
  • Keep release-state guidance explicit: HTTP access is documented now, while CLI and hosted MCP availability depends on the installed/server release and organization access.
  • Distinguish documentation search from web Search API usage and document that deferred content retrieval is unavailable.

Checks

  • npx --yes mint validate: passed.
  • npx --yes mint broken-links: passed; no broken links.
  • git diff --check main...HEAD: passed.
  • Full diff reviewed for scope and style.

Assumptions

Search is organization-gated; the public schema does not guarantee access. The current released CLI may not include kernel search; CLI releases that include Search support the documented command. The hosted MCP server currently exposes search_docs, while web Search API support is a separate capability. Deferred content retrieval remains a 404 stub. Availability notes should be rechecked when the CLI and MCP implementations ship.

@mintlify

mintlify Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Kernel 🟢 Ready View Preview Sep 22, 2026, 8:06 PM

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

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk level: Very Low. Approving.

The diff is documentation-only on the Mintlify site: a new Search guide (search.mdx), a sidebar entry in docs.json, and short cross-links in the CLI and MCP docs pages. No application logic, auth, permissions, infrastructure, or schema changes. No CODEOWNERS file, so a code owner review is not required. This PR has no prior approval.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk level: Very Low. Existing approval stands.

Re-checked the full diff after a325ab2 (Use provider-neutral search examples). The change set is still documentation-only on the Mintlify site:

  • search.mdx — new Search guide (HTTP examples, provider discovery, filters, CLI/MCP availability notes)
  • docs.json — sidebar entry for that page
  • reference/cli.mdx and reference/mcp-server/tools/search-docs.mdx — short cross-links

The commit since the prior approval only rewrites one paragraph in search.mdx so automatic routing is described as the default and provider-specific strategies are called advanced. No application logic, auth, permissions, infrastructure, or schema changes. No CODEOWNERS file, so a code owner review is not required.

Risk did not increase, so the existing approval is unchanged and this review is a comment only.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

This branch was successfully deployed

1 active deployment
staging a325ab2d Deployed Sep 22, 2026 by mintlify[bot]
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.

1 participant