Search a published documentation space

Outcome

Search titles, summaries, and published body text in one public documentation space. Anonymous; only published versions are matched.

These examples were captured from the local Worker. Deployment, publication and retrieval are verified separately for each environment; local examples do not establish external provider delivery.

Before you start

• Inspect the credential identity with topolo whoami and the exact action with topolo actions get before preparing input.

• Use an active public documentation space with an explicitly published document. Public retrieval never grants access to application mutations.

Discover the target

topolo actions get app_topolo_docs.public_search.query --detail --json
Use the public space and document slugs in an existing public reader URL or a verified documents.publish result; discover published documents through public_machine.index.

Input fields

Interpret the response

results contains only explicitly published matches in this active public space. Each result includes a display record, locale, contentHash, snippet and rank. It does not expose the private workspace or draft body.

Worked examples

The following inputs and responses were captured from the local Docs worker fixture. Auth and Nexus dependencies are simulated. Identifiers, URLs and timestamps are illustrative fixture values. Discover your own identifiers and choose an appropriate test resource; copying a fixture identifier does not make it valid in your environment. For workspace-bound calls, set DOCS_WORKSPACE_ID to the identifier returned by resource discovery. Run validation and planning first; the final call requires the intended effect to be authorized.

Minimal example

Save the input as payload.json:

{
  "spaceSlug": "reference-minimal",
  "q": "token",
  "limit": 5
}

CLI:

topolo actions validate app_topolo_docs.public_search.query --data @payload.json --json
topolo actions plan app_topolo_docs.public_search.query --data @payload.json --json
topolo actions call app_topolo_docs.public_search.query --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.public_search.query",
    "input": {
      "spaceSlug": "reference-minimal",
      "q": "token",
      "limit": 5
    }
  }
}

Captured local response · HTTP 200:

{
  "query": "token",
  "space": {
    "id": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
    "slug": "reference-minimal",
    "title": "minimal integration reference",
    "defaultLocale": "en"
  },
  "results": [
    {
      "document": {
        "id": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4",
        "parentId": null,
        "slug": "rotate-token",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token."
      },
      "locale": "en",
      "contentHash": "f14fd31c10cbbf734ad4677c8c68f7036d2f3625815ed61465ff8375acd5e0b6",
      "snippet": "Rotate a token Open credential settings, replace the token and verify a read.",
      "rank": -1.6923076923076922e-06
    }
  ]
}

results contains only explicitly published matches in this active public space. Each result includes a display record, locale, contentHash, snippet and rank. It does not expose the private workspace or draft body.

Workflow example

Save the input as payload.json:

{
  "spaceSlug": "reference-workflow",
  "q": "token",
  "limit": 5
}

CLI:

topolo actions validate app_topolo_docs.public_search.query --data @payload.json --json
topolo actions plan app_topolo_docs.public_search.query --data @payload.json --json
topolo actions call app_topolo_docs.public_search.query --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.public_search.query",
    "input": {
      "spaceSlug": "reference-workflow",
      "q": "token",
      "limit": 5
    }
  }
}

Captured local response · HTTP 200:

{
  "query": "token",
  "space": {
    "id": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
    "slug": "reference-workflow",
    "title": "workflow integration reference",
    "defaultLocale": "en"
  },
  "results": [
    {
      "document": {
        "id": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38",
        "parentId": null,
        "slug": "rotate-token",
        "title": "Rotate an integration token",
        "summary": "Safely replace an integration token."
      },
      "locale": "en",
      "contentHash": "f14fd31c10cbbf734ad4677c8c68f7036d2f3625815ed61465ff8375acd5e0b6",
      "snippet": "Rotate a token Open credential settings, replace the token and verify a read.",
      "rank": -0.5042990213106258
    }
  ]
}

results contains only explicitly published matches in this active public space. Each result includes a display record, locale, contentHash, snippet and rank. It does not expose the private workspace or draft body.

Verify the result

• Require space.slug to match spaceSlug and results.length not to exceed limit when supplied. Follow the published record and compare its contentHash before citation.

Errors and recovery

• HTTP 401 · authentication_required: Authenticate again or provide a valid Topolo API key.

• HTTP 403 · permission_denied: Grant the credential permission required by this action and the required resource binding.

• HTTP 429 · rate_limited: Wait for Retry-After when present, then retry without parallel duplicate calls.

• HTTP 422 · invalid_input: Correct the payload using inputSchema, then validate before retrying.

• HTTP 503 · dependency_unavailable: Retry the action. If it continues, inspect the structured error details using the request ID.

This action does not change service state.

Evidence boundary

These examples establish local handler behavior and schema validity. They do not establish runtime permission parity, a deployed development/staging result or production completion. Preserve the actual request identifier and perform the verification reads after an authorized live call.