Skip to main content
Glama

BlockRazor Docs

sendFeedback

Report an issue in the documentation of BlockRazor so the team can fix it. Use it whenever, while helping a user, you come across content that is outdated, contradictory, missing information, or otherwise unhelpful. Also use it when the user themselves reports a problem with the docs, even if you could not verify it yourself. If it's your own observation, do a quick sanity check that the issue is real before reporting — no need to exhaustively re-read the page. Send one call per distinct issue and do not report the same issue twice in a conversation. Do not use this tool to confirm that a page is accurate; it is for reporting problems only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
goalNoThe broader end goal you were ultimately trying to accomplish (as/on behalf of the user) when you hit this issue. Gives the team the context you were working towards. Optional.
contentYesExplain the issue in full, as if writing to a documentation maintainer who never saw this conversation. Describe what is wrong, where on the page it appears (quote the exact sentence or section title when possible), what the user was trying to do, and, when relevant, what the correct or expected information should be. Write a few clear, specific sentences in English. Never include personal or confidential information from the conversation. Up to 2048 characters.
pageUrlYesThe full URL of the page the issue is about (e.g. https://docs.blockrazor.io//getting-started), so the finding is linked to the exact page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / goal / maxLength
      Added value: +1024
  2. Changed4 schema fields changed
    • removedInput schema / properties / category
      Removed value: -{
      -  "description": "The kind of issue. \"content-outdated\": the content was correct at some point but no longer matches the current product or reality. \"incoherence\": the content contradicts itself or another page. \"content-gap\": information the reader needs is missing entirely, whether or not it was ever documented. \"other\": only as a last resort when none of the above fits.",
      -  "enum": [
      -    "content-outdated",
      -    "content-incorrect",
      -    "content-gap",
      -    "other"
      -  ],
      -  "type": "string"
      -}
    • addedInput schema / properties / goal
      Added value: +{
      +  "description": "The broader end goal you were ultimately trying to accomplish (as/on behalf of the user) when you hit this issue. Gives the team the context you were working towards. Optional.",
      +  "type": "string"
      +}
    • changedInput schema / properties / pageUrl / description
      Previous value: -"The full URL of the page the issue is about (e.g. https://docs.blockrazor.io//getting-started). Provide it whenever you can so the finding is linked to the exact page."New value: +"The full URL of the page the issue is about (e.g. https://docs.blockrazor.io//getting-started), so the finding is linked to the exact page."
    • changedInput schema / required
      Previous value: -[
      -  "category",
      -  "content"
      -]New value: +[
      +  "content",
      +  "pageUrl"
      +]
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate this is not read-only, not idempotent, and not destructive. The description adds useful behavioral constraints beyond that: one call per distinct issue, no duplicate reports, and a sanity check for personal observations. It does not detail submission or response behavior, but that is a minor omission for a feedback tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose, and every sentence earns its place: conditions, verification expectations, deduplication rule, and an explicit non-use case. There is no fluff or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter feedback tool with fully documented schema, the description covers when to use it, when not to, how to batch issues, and how to handle unverified user reports. No output schema is present, and nothing needed for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the schema already explains content, pageUrl, and goal in detail, including length limits and examples. The description reinforces the reporting semantics but adds no parameter-level details beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Report an issue in the documentation of BlockRazor'. This clearly distinguishes it from sibling tools like askQuestion, getPage, and searchDocumentation, which retrieve or ask rather than report.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit triggers: use when encountering outdated, contradictory, or missing docs, or when the user reports a problem even if unverified. It also gives exclusions: do not use to confirm a page is accurate, send one call per issue, and avoid reporting the same issue twice.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources