Skip to content
Vispero CORADocs

cora-mcp-guidance

get_fix_guidance’s result: how to fix one rule’s failures in any framework, whole, as the rule’s guidance page in CORA’s docs gives it. It gives the rule in plain language, who its failures affect, each situation the rule fails in with its fix, and the fixes that silence the rule or look right but still fail people, with why. Given the project’s framework, it adds the fixes that differ there, in that framework’s syntax.

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-guidance/v1.json in the @vispero/cora package and at https://cora.vispero.com/docs/0.10/schemas/cora-mcp-guidance/v1.json.

  • format (“cora-mcp-guidance”, required): The result’s format, always cora-mcp-guidance.
  • version (1, required): The version of cora-mcp’s tool surface, which every result and error of its tools declares.
  • rule (string, required): The rule’s ID, as the call named it, such as axe/image-alt.
  • title (string, required): The rule in plain language, such as “Buttons need a name”.
  • affects (array of “screen-reader”, “low-vision”, “color-vision”, “deaf”, “keyboard”, “voice-control”, “dexterity”, “cognitive” or “motion”, required): Who the rule’s failures affect, at least one, most affected first, each named for what they use or need, such as screen-reader for people who use a screen reader or a braille display, or keyboard for people who use a keyboard or a switch device instead of a mouse.
  • patterns (array of objects, required): Each situation the rule fails in, at least one, with its fix in any framework.
  • wrongFixes (array of objects, required): The fixes that silence the rule, or look right but still fail people, each with why; empty for a rule that has none.
  • framework (object): The fixes that differ in the framework the call’s framework named, in that framework’s syntax; absent when the call named none, or when the rule’s fixes are the same there.
  • docsUrl (string, required): The address of the rule’s guidance page in the docs of the cora-mcp release that answered, to show a person.

patterns[]

Section titled “patterns[]”

Also at: framework.patterns[]

  • when (string, required): The situation, such as “The button shows only an icon”, or for a rule axe-core only asks to review, what it asks about.
  • fix (string, required): What to do, in Markdown.
  • example (string): The markup after the fix: HTML in the guidance for any framework, and the framework’s own syntax in a framework’s section; absent where an example would not help.

wrongFixes[]

Section titled “wrongFixes[]”

Also at: framework.wrongFixes[]

  • fix (string, required): The fix, in Markdown, such as “Adding only a title attribute”.
  • why (string, required): Why it fails, in Markdown.

framework

Section titled “framework”
  • name (“react”, required): The framework, as the call named it, such as react.
  • patterns (array of objects, required): Each situation whose fix differs in the framework, at least one, with its fix there.
  • wrongFixes (array of objects, required): The fixes that look right in the framework but still fail people, each with why; empty when it has none of its own.