Title96/100
commercetools documentation Search
The title clearly communicates the tool’s action and subject. Keep it concise.
Description92/100
Retrieves documentation content chunks that are semantically similar to the input. Use this tool to find domain concepts, business behavior explanations, and reference material from the commercetools documentation. Inline links in the content use markdown format [text](url). The URL usually points to the commercetools documentation portal but can also point to API reference docs or external resources. Relative links resolve against "https://docs.commercetools.com". Appending ".md" to a documentation URL fetches the markdown source of that page. Example: a relative link "./api/predicates/query" resolves to "https://docs.commercetools.com/api/predicates/query.md" If you are requesting only one specific content type, pass the same value for crowding and limit. The mean size of a documentation chunk returned is in the range of 500-600 tokens.
The description explains the capability, when to use it, and what to expect.
Inputs93/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
query
The text to find semantically similar content to. Full sentences describing the context of the situation or problem yield better results than just keywords.
Clear enough to supply this argument.
limit
The maximum number of results to return across all content types.
Clear enough to supply this argument.
crowding
The maximum number of results to return per document type. Avoids over-representation of certain content types.
Clear enough to supply this argument.
contentTypes
return only the given content types to focus or expand the defaults. "apiType" and "apiEndpoint" return natural language descriptions of the REST API surface. "guidedDocs" includes best practice guides, tutorials, and learning content. "referenceDocs" covers reference material. "userDocs" is end-user-facing documentation. "otherDocsPage" covers content that does not fit the other categories. "Skill" includes reference content linked from agent skills.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
excludeContentTypes
exclude the given content types from the results.
Clear enough to supply this argument.
products
return only content about the given products. For example, if your application uses commercetools Frontend, add "Frontend" to the defaults, or, if you are not using the OOTB Checkout UI, remove "Checkout"
Clear enough to supply this argument.
excludeProducts
exclude the given products from the results.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
Annotations50/100
Declare idempotentHint, openWorldHint based on the tool’s actual behavior.
{
"title": "commercetools documentation Search",
"readOnlyHint": true,
"destructiveHint": false
}Output schema0/100
No output schema is declared. Add one for structured results so clients can interpret returned fields.
Not declared