shipper_docs_search
shipper_docs_search
Section titled “shipper_docs_search”Search the Shipper documentation corpus. Returns matching pages with relevance-ranked snippets so an agent can decide which page(s) to fetch in full.
When to use
Section titled “When to use”Use this when an agent needs to discover relevant Shipper docs pages or snippets before fetching a full page.
Behavior hints
Section titled “Behavior hints”- readOnlyHint: true — The tool only reads state and does not intentionally modify the repository.
- idempotentHint: true — Retrying the same call is expected to be safe once the target state is reached.
- openWorldHint: false — The tool does not reach GitHub or other external systems outside the MCP server.
Input schema
Section titled “Input schema”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | yes | - | - |
| limit | integer | no | - | - |
Example call
Section titled “Example call”{ "query": "setup agents", "limit": 2}Example result
Section titled “Example result”Match 1path: agents/setuptitle: Repository setup for agentsscore: 18.00snippet: Configure a repository so any coding agent can run Shipper reliably...Error modes
Section titled “Error modes”- Corpus unavailable or read failure: Shipper documentation corpus is unavailable. Rebuild @baremetallabs-ai/shipper-mcp with the docs snapshot or set SHIPPER_DOCS_PATH to an absolute docs corpus path.