Discover published documentation records

Outcome

List citation-ready machine record URLs for the explicitly published documents in one public documentation space.

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_machine.index --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

documents contains published document/version identifiers and bounded retrieval URLs. Follow machineUrl for the body. Do not interpret the index as an authorization grant for executable actions.

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"
}

CLI:

topolo actions validate app_topolo_docs.public_machine.index --data @payload.json --json
topolo actions plan app_topolo_docs.public_machine.index --data @payload.json --json
topolo actions call app_topolo_docs.public_machine.index --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.public_machine.index",
    "input": {
      "spaceSlug": "reference-minimal"
    }
  }
}

Captured local response · HTTP 200:

{
  "formatVersion": 1,
  "spaceSlug": "reference-minimal",
  "documents": [
    {
      "documentId": "doc_de0efe08-781e-4e60-9d7a-2a48b6dd4dd4",
      "versionId": "docver_387e2601-28ef-4d73-8a60-ab3e37fdce87",
      "title": "Rotate an integration token",
      "summary": "Safely replace an integration token.",
      "ownerAppId": null,
      "url": "https://docs.test/s/reference-minimal/rotate-token",
      "machineUrl": "https://docs.test/api/public/docs/reference-minimal/rotate-token/machine.json"
    }
  ],
  "actions": {
    "readerUrl": "https://docs.test/reference/actions",
    "discovery": "Use topolo actions or topolo_search_actions with the active credential. Public documentation does not grant runtime access."
  }
}

documents contains published document/version identifiers and bounded retrieval URLs. Follow machineUrl for the body. Do not interpret the index as an authorization grant for executable actions.

Workflow example

Save the input as payload.json:

{
  "spaceSlug": "reference-workflow"
}

CLI:

topolo actions validate app_topolo_docs.public_machine.index --data @payload.json --json
topolo actions plan app_topolo_docs.public_machine.index --data @payload.json --json
topolo actions call app_topolo_docs.public_machine.index --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_docs.public_machine.index",
    "input": {
      "spaceSlug": "reference-workflow"
    }
  }
}

Captured local response · HTTP 200:

{
  "formatVersion": 1,
  "spaceSlug": "reference-workflow",
  "documents": [
    {
      "documentId": "doc_453b15f4-06fc-4366-ae42-adf1f10d9d38",
      "versionId": "docver_81f1572d-43ea-45fe-b0dd-0f550c94d80a",
      "title": "Rotate an integration token",
      "summary": "Safely replace an integration token.",
      "ownerAppId": null,
      "url": "https://docs.test/s/reference-workflow/rotate-token",
      "machineUrl": "https://docs.test/api/public/docs/reference-workflow/rotate-token/machine.json"
    }
  ],
  "actions": {
    "readerUrl": "https://docs.test/reference/actions",
    "discovery": "Use topolo actions or topolo_search_actions with the active credential. Public documentation does not grant runtime access."
  }
}

documents contains published document/version identifiers and bounded retrieval URLs. Follow machineUrl for the body. Do not interpret the index as an authorization grant for executable actions.

Verify the result

• Follow a machineUrl and compare its versionId to the index entry; refresh the index if a new version was published.

Errors and recovery

• HTTP 404 · not_found: Use an active public documentation space with published documents.

This read does not modify documentation.

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.