Skip to main content
Glama

build_report

Generates a self-contained HTML literature-review report from a bibliometric run, covering scope, themes, connections, gaps, reading lists, and methods; offers review or question layout.

Instructions

Write one self-contained HTML report. layout="review" (default) is organised for a literature review: a one-page brief, scope (records in and out), one card per theme (what it is about, papers to read first, growth, links to other themes), how themes connect, evolution, research agenda (gaps) and a methods appendix, with RIS/BibTeX reading lists and a methods paragraph to download. layout="questions" lists every question. level: 1 = the published S3 method, 2 = + two-mode and knowledge graph (default), 3 = + prediction (prediction=True is the same; a few minutes more). Default path: the run folder.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "run_id": "<run_id>"
    },
    "name": "build_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
levelNo
titleNo
layoutNoreview
run_idYes
predictionNo
output_pathNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.12.2

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does disclose useful behavior: artifacts produced (downloadable reading lists, methods paragraph), that level 3 costs "a few minutes more," and that output defaults to the run folder. It does not say what happens if output_path already exists (overwrite?), whether the report is written to disk or returned, or any permission/failure considerations.

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, then the layout and level semantics, with no filler sentences. It is written as long run-on clauses that are harder to scan than a short bulleted structure, but every clause carries information an agent needs.

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?

An output schema exists, so return values need not be explained, and the description covers the two behavioral parameters thoroughly. For a 6-parameter tool with zero schema description coverage, the only real shortfalls are title and output_path semantics.

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?

Schema coverage is 0%, so the description must compensate, and it largely does: it defines the meaningful values of layout (review/questions) and level (1/2/3 with composition), and clarifies the interaction between prediction and level. Gaps remain for title (never mentioned) and output_path (only indirectly implied by "Default path: the run folder"), and run_id semantics are left to the parameter name.

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 artifact: "Write one self-contained HTML report," then enumerates exactly what the review layout contains (brief, scope, theme cards, agenda, methods appendix, RIS/BibTeX lists). It does not explicitly contrast with siblings like export_results or export_networks, so the agent must infer the boundary, but the resource is unambiguous.

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?

Gives strong decision criteria for the two main knobs: layout="review" vs layout="questions" with what each produces, and level 1/2/3 with what each adds plus which is default. It also notes prediction=True is equivalent to level 3. Missing is any statement of when to prefer this tool over the sibling export tools.

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