Skip to main content
Glama
gosodax
by gosodax

docs_sendFeedback

Read-only

Report outdated, contradictory, or missing documentation details to the team for correction. Provide the page URL and a clear description of the issue.

Instructions

[SDK Docs] Report an issue in the documentation of Docs 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.sodax.com//getting-started), so the finding is linked to the exact page.
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe operation. The description adds valuable behavioral context beyond this: instructing a sanity check for personal observations, avoiding duplicate reports, and sending one call per distinct issue. These exceed what annotations provide.

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 appropriately sized and front-loaded with the main purpose. Every sentence earns its place: triggers, exclusions, call-count rules, and a clear statement of scope. 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 simple feedback-reporting tool with no output schema, the description covers all necessary context: when to use, how to structure feedback, what to avoid (confidential info, duplicates), and explicit exclusions. It is complete for an agent to decide and invoke correctly.

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% for all three parameters, so the schema already fully documents each parameter. The tool description does not add new parameter-specific meaning; it focuses on usage guidelines rather than enriching parameter semantics.

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 clearly states the verb 'Report an issue' and the resource 'documentation of Docs'. It distinguishes itself from sibling tools like docs_getPage and docs_searchDocumentation by focusing on reporting problems rather than retrieving or searching docs.

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

Usage Guidelines4/5

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

Provides explicit when-to-use scenarios: encountering outdated/contradictory/missing content, user-reported issues, and even when not to use it (to confirm accuracy). It also gives constraints like 'send one call per distinct issue' and 'do not report the same issue twice'. However, it does not explicitly name alternative tools, so it falls slightly short of the highest bar.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/gosodax/builders-sodax-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server