Skip to main content
Glama
mistakeknot

interdeep

by mistakeknot

compile_report

Compile research findings and sources into structured markdown reports with citations for organized documentation.

Instructions

Compile research findings and sources into a structured markdown report with citations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesReport title.
queryNoThe original research query.
findingsYesList of findings, each with title, content, and optional confidence.
sourcesYesList of sources, each with url, title, and optional relevance.
metadataNoOptional metadata key-value pairs for the report frontmatter.

Implementation Reference

  • The handler function _handle_compile_report that executes the logic for compiling a report.
    async def _handle_compile_report(arguments: dict) -> list[TextContent]:
        title = arguments.get("title", "Untitled Report")
        query = arguments.get("query", "")
        findings = arguments.get("findings", [])
        sources = arguments.get("sources", [])
        metadata = arguments.get("metadata")
        try:
            report = compile_markdown_report(
                title=title,
                findings=findings,
                sources=sources,
                query=query,
                metadata=metadata,
            )
            return _ok({"report": report})
        except Exception as e:
            logger.exception("compile_report failed")
            return _err(f"Report compilation failed: {e}")
  • The definition of the compile_report tool, including its input schema and description.
    Tool(
        name="compile_report",
        description="Compile research findings and sources into a structured markdown report with citations.",
        inputSchema={
            "type": "object",
            "properties": {
                "title": {
                    "type": "string",
                    "description": "Report title.",
                },
                "query": {
                    "type": "string",
                    "description": "The original research query.",
                    "default": "",
                },
                "findings": {
  • The registration of the compile_report tool in the _HANDLERS dictionary.
    "compile_report": _handle_compile_report,
Behavior2/5

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

With no annotations, the description carries full burden but only states the output format ('structured markdown report with citations'). It misses behavioral details like whether the tool modifies data, requires specific permissions, handles errors, or has performance constraints (e.g., rate limits), which are critical for a tool with multiple parameters and nested objects.

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 a single, efficient sentence that front-loads the core purpose without unnecessary details. Every word contributes to understanding the tool's function, making it appropriately sized and well-structured.

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

Completeness2/5

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

Given the tool's complexity (5 parameters with nested objects) and lack of annotations or output schema, the description is insufficient. It doesn't cover behavioral aspects, output details, or error handling, leaving significant gaps for the agent to operate effectively in a research compilation context.

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%, providing baseline documentation for all parameters. The description adds minimal value by implying that 'findings' and 'sources' are compiled into the report, but doesn't elaborate on parameter interactions or usage beyond what the schema already describes.

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?

The description clearly states the action ('compile') and the output ('structured markdown report with citations'), specifying the resource as 'research findings and sources'. It distinguishes from siblings like 'extract_batch' or 'extract_content' by focusing on compilation rather than extraction, though it doesn't explicitly contrast 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?

No guidance is provided on when to use this tool versus alternatives like 'research_status' or other siblings. The description implies usage for compiling research, but lacks explicit context, prerequisites, or exclusions, leaving the agent to infer appropriate scenarios.

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/mistakeknot/interdeep'

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