Skip to content
Vispero CORADocs

cora-mcp-error

The error a cora-mcp tool returns when a call fails: a result marked isError, with no structured content, whose one text block holds this object as JSON. It gives the error’s code, message and hint, the address of the code’s entry in the error reference, what a person or an agent can do about it, and the problems its message lists. Each text has the credentials cora-mcp finds in it, such as tokens and a URL’s secret parameters, redacted.

Each version lists its fields, then a section for each object they hold, headed by its path, in which [] stands for each entry of a list. Where objects of several kinds share a path, each kind has a section, named by the field that tells them apart. A field marked required is in every object of its kind, and the description of any other says when it is absent.

Version 1

Section titled “Version 1”

The version this release writes. Its JSON Schema is schemas/cora-mcp-error/v1.json in the @vispero/cora package and at https://cora.vispero.com/docs/0.10/schemas/cora-mcp-error/v1.json.

  • format (“cora-mcp-error”, required): The error’s format, always cora-mcp-error.
  • version (1, required): The version of cora-mcp’s tool surface, which every result and error of its tools declares.
  • code (string, required): The error’s code, such as mcp.invalid-argument, which the error reference lists with what went wrong and what to do: https://cora.vispero.com/docs/reference/errors/
  • message (string, required): What went wrong, in sentences; a message that lists problems gives each on a line of its own under its first line. Cut short, ending with …, when it is long.
  • hint (string, required): One line on what to do about the error, cut short, ending with …, when it is long.
  • docsUrl (string, required): The address of the code’s entry in the error reference of the cora-mcp release that answered.
  • nextActions (array of objects, required): What a person or an agent can do about the error, such as a command to run; empty when the error names nothing to do. They are kept in order, the first always and each other while the list has room, and each action’s text is cut short, ending with …, when it is long.
  • issues (array of objects): The problems the message lists, each with its path, such as an invalid argument’s, listed while the result has room, each path and message cut short, ending with …, when it is long. Absent when the message lists none, or when none fits.
  • omittedIssues (integer): How many of the problems the result leaves out for its size; absent when it leaves out none.

nextActions[] where kind is “run”

Section titled “nextActions[] where kind is “run””
  • kind (“run”, required): What the action is: run a command, open a page, or edit a file.
  • command (string, required): The command to run, such as npx playwright install chrome.

nextActions[] where kind is “open”

Section titled “nextActions[] where kind is “open””
  • kind (“open”, required): What the action is: run a command, open a page, or edit a file.
  • url (string, required): The address of the page to open.

nextActions[] where kind is “edit”

Section titled “nextActions[] where kind is “edit””
  • kind (“edit”, required): What the action is: run a command, open a page, or edit a file.
  • file (string, required): The path of the file to edit.

issues[]

Section titled “issues[]”
  • path (string, required): Where the problem is in what the error is about, such as a file or a call’s arguments, as a path such as fixes[1].issue or findings[2].location.kind; empty for the whole of it.
  • message (string, required): What is wrong there, such as Expected 32 lowercase hex characters.