Skip to main content
Glama

report

Submit feedback on search utility with optional notes to help Giskard improve semantic web search quality.

Instructions

Report whether the search was useful. Helps Giskard improve.

useful: True if the result helped you, False if it didn't
note: optional — what was missing or what worked well

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
usefulYes
noteNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • server.py:142-157 (registration)
    The report tool is registered using the @mcp.tool() decorator from FastMCP, which registers it as an MCP tool
    @mcp.tool()
    def report(useful: bool, note: str = "") -> str:
        """Report whether the search was useful. Helps Giskard improve.
    
        useful: True if the result helped you, False if it didn't
        note: optional — what was missing or what worked well
        """
        entry = {
            "ts":     datetime.utcnow().isoformat(),
            "useful": useful,
            "note":   note,
            "service": "search",
        }
        with open(FEEDBACK_FILE, "a") as f:
            f.write(json.dumps(entry) + "\n")
        return "Feedback recorded. Thank you."
  • The handler function for the 'report' tool. It records user feedback about search usefulness to a JSONL file. Takes a boolean 'useful' parameter and optional 'note' string, writes timestamped entry to feedback.jsonl, and returns confirmation message.
    def report(useful: bool, note: str = "") -> str:
        """Report whether the search was useful. Helps Giskard improve.
    
        useful: True if the result helped you, False if it didn't
        note: optional — what was missing or what worked well
        """
        entry = {
            "ts":     datetime.utcnow().isoformat(),
            "useful": useful,
            "note":   note,
            "service": "search",
        }
        with open(FEEDBACK_FILE, "a") as f:
            f.write(json.dumps(entry) + "\n")
        return "Feedback recorded. Thank you."
  • Helper constant defining the path to the feedback file where report entries are stored (feedback.jsonl)
    FEEDBACK_FILE = Path(__file__).parent / "feedback.jsonl"
Behavior2/5

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

With no annotations provided, description carries full disclosure burden. Mentions 'Helps Giskard improve' indicating side effects/feedback loop, but omits critical behavioral details: whether operation is synchronous, idempotent, possible failure modes, or data retention implications.

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?

Extremely compact with zero redundant sentences. Front-loaded purpose statement followed by parameter documentation. Slightly informal structure (colon-separated param definitions rather than prose) is acceptable given brevity and clarity.

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?

Adequate for a simple 2-parameter feedback tool with existing output schema. Missing explicit linkage to specific sibling search tools (search_web/search_news) and return value explanation, though output schema mitigates the latter gap.

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

Parameters4/5

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

Compensates effectively for 0% schema description coverage by inline documentation: defines 'useful' boolean semantics (helped vs didn't help) and 'note' purpose (missing features/positive feedback). Clearly marks note as optional, matching schema's default value.

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 specific action ('Report') and scope ('whether the search was useful') with clear resource context. Effectively distinguishes from data-retrieval siblings (get_invoice, search_news, etc.) by identifying this as a feedback mechanism rather than a query tool.

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

Usage Guidelines3/5

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

Implies usage context through 'the search' reference, suggesting use after search operations, but lacks explicit guidance on WHEN to invoke (e.g., 'Call after search_web/search_news') or prerequisites. No alternatives or exclusions mentioned.

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/giskard09/giskard-search'

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