Skip to main content
Glama

Farm.js Docs

Submit documentation feedback

submit_feedback

Submit machine-readable documentation feedback. The payload is validated against the site's configured agent feedback schema before delivery.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contextNo
payloadYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageYes
acceptedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, and destructiveHint=false, establishing this as a non-idempotent, non-destructive write. The description contributes real beyond-annotation detail: the payload is validated against a site-configured agent feedback schema before delivery, so the agent knows submissions can be rejected. It does not say what happens on validation failure or where feedback is delivered.

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?

Two sentences, no filler, and the key fact (schema validation before delivery) is stated up front. Nothing could be cut without losing information.

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

Completeness3/5

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

An output schema exists, so return values need not be explained. However, for a non-idempotent mutation with an opaque payload, the description omits the most operationally important detail: that the agent should retrieve the feedback schema first (notably via the sibling get_config_schema) and what the context fields are for.

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 0% for two parameters, including a nested context object (url, page, slug, locale, source) and an open-ended payload object with additionalProperties. The description explains that the payload shape is governed by an external site-configured schema, which is genuinely useful framing, but it says nothing about the context fields the agent is expected to populate.

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

Purpose4/5

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

States a specific verb and resource ("Submit ... documentation feedback") with the qualifier "machine-readable." It is clearly the only write/submit tool among a set of read-only siblings, though it never explicitly contrasts itself with them.

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

Usage Guidelines2/5

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

The description never says when to call this tool, what conditions require feedback submission, or what alternatives exist. The agent must infer usage purely from the name and the fact that all siblings are read operations.

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.