Skip to content

submit-feedback

Tool name: submit-feedback

Report a documentation page that is wrong or incomplete.

Input schema

pathstring, [ 1 .. 1000 ] charactersrequired

Path or URL of the documentation page the feedback is about (e.g. /guides/auth).

summarystring, [ 1 .. 500 ] charactersrequired

One sentence that names what is wrong with the page.

detailsstring, <= 4000 characters

Expected versus actual behavior, missing steps, or the snippet that failed.

targetFeaturestring, <= 500 characters

The API or feature the page documents.

Input example
{
  "path": "string",
  "summary": "string",
  "details": "string",
  "targetFeature": "string"
}

Output schema

statusstringrequired
Value:"received"
pagestringrequired

Absolute URL of the page the feedback refers to.

messagestringrequired
Output example
{}