Skip to main content
Glama

sendFeedback

Report an issue in the documentation of Sigrex Documentation 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.sigrex.io//getting-started), so the finding is linked to the exact page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, so the write/side-effect profile is known; the description confirms this by framing the tool as a submission the team acts on. It adds real behavior beyond annotations: one call per distinct issue, no duplicate reports per conversation, and a sanity-check expectation before reporting. It does not say whether feedback is rate-limited or what confirmation comes back, which keeps it out of the top band.

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?

Front-loaded with the core action before the detailed triggers, and every sentence carries a rule or constraint rather than filler. It is on the long side and the de-duplication rule could be tightened, but nothing is padding.

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

Completeness4/5

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

For a 3-parameter, no-output-schema reporting tool, the description supplies the trigger conditions, preconditions, and de-duplication policy an agent needs. The one gap is that with no output schema, the description never says what a successful submission returns or looks like.

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%, so all three parameters (goal, content, pageUrl) are already fully documented in the schema, including format, character limit, and confidentiality rules. The description adds no parameter-level meaning beyond that, so the 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?

States a specific verb and resource ('Report an issue in the documentation of Sigrex Documentation') plus the consequence ('so the team can fix it'). The closing exclusion ('Do not use this tool to confirm that a page is accurate') sharply bounds the purpose against the nearest read-oriented siblings like getPage/searchDocumentation.

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?

Explicit triggers are enumerated (outdated, contradictory, missing information, unhelpful) and it covers the indirect case ('when the user themselves reports a problem... even if you could not verify it yourself'). It also gives a precondition (do a quick sanity check) and an anti-pattern (do not use to confirm accuracy), leaving almost nothing to inference.

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