Documentation

Discover and inspect

Find a candidate tool, then read its fixed contract before creating a Run.

View as Markdown
On this page

purrkey discover

Read matchReasons and limitations for each candidate. retrievalMode can be hybrid or keyword_fallback; semanticCoverage describes search coverage, not proof that a candidate will answer your task.

Shell
purrkey discover --query 'public video comments' --limit 5
FlagMeaning
--queryRequired capability description.
--limitCandidate count, default 5; the API accepts 1–20.
--outputOptional path for the complete JSON response.

purrkey inspect

Read inputSchema, outputSchema, inputExamples, limitations, behavior and delivery. Copy the returned tool and price revisions into the Run request; never guess the input fields.

Shell
purrkey inspect --tool '<toolId>' --revision '<toolRevision>'
FlagMeaning
--toolRequired tool ID from discovery or the catalog.
--revisionOptional tool revision; use the discovered revision to inspect that exact contract.
--outputOptional path for the complete JSON response.

purrkey tools

Reads the accessible tool directory. This command does not expose catalog pagination flags; use GET /v1/tools when you need cursor-based browsing or filtering.

Shell
purrkey tools --output tools.json