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.

TDQS

A4.4/5.0
Behavior4/5

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

Annotations indicate readOnlyHint=false and destructiveHint=false, consistent with a non-destructive write operation. The description adds context about the tool's purpose (reporting to a team) and constraints (one issue per call, no duplicates), which goes beyond annotations. However, it does not detail the internal behavior (e.g., how feedback is stored or who receives it), but that is acceptable for a simple 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.

Conciseness4/5

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

The description is moderately concise (four sentences) and well-structured: first sentence states purpose, second lists usage conditions, third gives a sanity check rule, and fourth provides usage constraints. Every sentence adds value without redundancy. Slightly longer than necessary but still effective.

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?

Given the tool's simplicity (3 parameters, no output schema, no nested objects), the description covers all necessary aspects: when to use, what to include in content, how to handle observations vs. user reports, and constraints. An agent can reliably decide to invoke this tool and format the call correctly based on the description alone.

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 coverage is 100%: all three parameters have descriptions. The tool description reinforces the 'content' parameter with additional guidance (quote exact sentence, no personal info), but adds minimal new meaning beyond the schema. Baseline is 3, and the description does not significantly elaborate on parameters beyond what is already in the input schema.

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 states the tool is for reporting documentation issues in BlockRazor. It uses a specific verb ('Report an issue') and resource ('documentation of BlockRazor'), and distinguishes from sibling tools (askQuestion, getPage, searchDocumentation) by specifying it is only for reporting problems, not for asking questions or searching.

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?

The description provides explicit when-to-use conditions: when encountering outdated, contradictory, or missing info, or when the user reports a problem. It also gives when-not-to-use (do not use to confirm accuracy), and includes guidelines like one call per issue, not reporting same issue twice, and a sanity check before reporting.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: askQuestion provides synthesized answers, getPage fetches full page content, searchDocumentation returns search results, and sendFeedback reports issues. There is no overlap in functionality.

Naming Consistency5/5

All tool names follow a consistent camelCase verb_noun pattern (e.g., askQuestion, getPage, searchDocumentation, sendFeedback), ensuring predictability.

Tool Count5/5

With 4 tools covering documentation browsing, search, Q&A, and feedback, the count is well-scoped for the server's purpose without being too few or too many.

Completeness5/5

The tool set covers all necessary operations for a documentation server: retrieving pages, searching, asking questions, and reporting issues. There are no obvious gaps.

Resources