Documentation

ToolREST endpointAnnotations
search_product_docsGET /v1/docs/searchread-only, idempotent

Use it when the user asks how Platica works: product, interface, or API. It does not operate the workspace and it does not replace the other tools. It does not accept workspace.

The REST contract is in Documentation .


search_product_docs

FieldTypeRequiredDescription
qstring (1-200)yesText to search for in Platica's documentation.
limitinteger (1-8)noResults to return. Defaults to 5.
{
  "name": "search_product_docs",
  "arguments": {
    "q": "how to create a webhook",
    "limit": 3
  }
}

What to read from the response

FieldMeaning
results[].nameDocument name. The tool shows it in the Title column.
results[].topicTopic.
results[].snippetShort excerpt. It is not the full document.
returnedHow many results are in results.
foundTotal matches.