Skip to content

Document that anyapi search accepts a scope with no query - #17

Merged
kev1n merged 2 commits into
mainfrom
docs/cli-scope-only-search
Sep 5, 2026
Merged

Document that anyapi search accepts a scope with no query#17
kev1n merged 2 commits into
mainfrom
docs/cli-scope-only-search

Conversation

@kev1n

@kev1n kev1n commented Sep 5, 2026

Copy link
Copy Markdown
Member

The CLI reference still showed anyapi search <query> as the only form. anyapi-cli@0.9.0, published today from getanyapi-com/cli#17, makes the query optional: --category or --platform alone is a complete search.

Two changes in cli.mdx:

  • The command table row becomes anyapi search [query] [--category <category>] [--platform <platform>] and says the query is optional from 0.9.0.
  • The prose under the table states the rule the gateway has enforced since #1013: ranked search takes any non-empty combination of a query, --category, and --platform, and ranking falls back from semantic to keyword when there is no query.

Measured against production with no key:

GET https://api.getanyapi.com/catalog/search?platform=reddit  ->  200, 11 results, no q

langchain.mdx is deliberately untouched. Its "This tool requires query" line is still true: langchain-anyapi declares query: str in its own tool surface and needs its own release.

Gates green locally: scripts/check-docs-nav.sh, scripts/check-agent-contract.sh, mint validate.

kev1n and others added 2 commits September 5, 2026 01:45
Three fixes, each verified against the live gateway or the published package.

`getanyapi.com/docs/langchain` 404s, so our open PR against LangChain's own
integrations tables (langchain-ai/docs#5886) had to point `docs_url` at a
GitHub README instead of at us. `langchain.mdx` serves that exact URL. Every
tool name, argument and default on it came from installing `langchain-anyapi`
0.1.0 from PyPI and printing each tool's `.name` and
`.args_schema.model_json_schema()`, not from the README.

The MCP page described only the hosted endpoint. `getanyapi-com/mcp` now
publishes a local stdio server that forwards to it, for clients that cannot
speak remote Streamable HTTP. The npx, Claude Code and Docker recipes are the
ones the MCP Registry entry `io.github.getanyapi-com/anyapi` declares at 0.1.2.

The page also told customers that `list_apis`, `search_apis` and `get_api` work
"without a key". They do not, and have not. Measured against production: an
anonymous `initialize` and `tools/list` both return 200, and `tools/call` on
each of those three returns HTTP 401 `unauthorized`. What is keyless is the
handshake and the tool listing. The note now says that, and points at
`GET /catalog` and `GET /catalog/search`, which really are keyless (both 200
with no credential). This documents current behavior and asks for no change to
it.

Quickstart now says `q` is optional on `/catalog/search`. Measured today:
`?platform=reddit` and `?category=social` each return 200, and a bare
`/catalog/search` returns 400 `"name q, category, or platform"`. The generated
API reference already had this right.

Gate: check-docs-nav.sh, check-agent-contract.sh, mint validate, and
mint broken-links all pass.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@kev1n
kev1n merged commit 459f3b5 into main Sep 5, 2026
2 checks passed
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