Documentation
| Tool | REST endpoint | Annotations |
|---|---|---|
search_product_docs | GET /v1/docs/search | read-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
| Field | Type | Required | Description |
|---|---|---|---|
q | string (1-200) | yes | Text to search for in Platica's documentation. |
limit | integer (1-8) | no | Results to return. Defaults to 5. |
{
"name": "search_product_docs",
"arguments": {
"q": "how to create a webhook",
"limit": 3
}
} What to read from the response
| Field | Meaning |
|---|---|
results[].name | Document name. The tool shows it in the Title column. |
results[].topic | Topic. |
results[].snippet | Short excerpt. It is not the full document. |
returned | How many results are in results. |
found | Total matches. |
Nota
If results is empty, the documentation has no match for that query. Don't invent the product detail from that.