Skip to main content
Glama

Create review

create_review

Submit Markdown or LaTeX documents to create a human review and receive the review ID plus review and feedback URLs.

Instructions

Create a review from markdown; returns the id and the review and feedback urls. The viewer renders GFM, Mermaid diagrams (mermaid fenced blocks), LaTeX math ($...$ inline, $$...$$ display), GFM footnotes, syntax-highlighted fenced code (label the language) and images (attach them with attach_asset). A flow, decision tree, state machine or architecture reads best as a mermaid diagram, since a plain code fence renders as monospace text. Optional project, session and source_path record where the draft came from, for the dashboard. kind="latex" (default "markdown") makes a research-paper review instead: markdown then carries raw LaTeX (a single .tex document), shown in a split viewer with a live server-compiled PDF, and the markdown rules do not apply. If the content is LaTeX (a .tex source_path, or a body with \documentclass or \begin{document}), set kind="latex"; a latex-enabled server rejects the create otherwise. kind cannot change later. Recreating a review in the other format makes a new review with a new id and url, and its comments and history do not carry over.

Input Schema

NameRequiredDescriptionDefault
kindNoreview kind; default markdown. latex = an Overleaf-style paper review. IMMUTABLE: you cannot change a review's kind later; re-creating a review in the other format makes a NEW, separate review with re-authored content (comments/history do not carry over). Warn the human and offer to link the two.
titleNo
projectNo
sessionNo
markdownYesthe document to review (raw LaTeX when kind=latex)
templateNofor a latex review, start from a named template instead of a blank .tex: it seeds the source (unless you also pass markdown) and supplies the document class/style. Bundled: ieee, acm, arxiv, lncs, elsevier (CTAN classes). Download-on-miss (fetched + cached on first use): acl, iclr2026, and more. GET /api/latex/templates lists the current ids; an unknown id returns 400 with the list. A template only applies at creation of a latex review; there is no re-template of an existing review (see the kind caveat: re-creating in another format is a new review).
source_pathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.4

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare that this is a non-read-only, non-destructive, closed-world write. The description adds genuinely load-bearing behavior beyond that: kind is immutable, a latex-enabled server rejects non-latex creates, and re-creating in another format produces a new id/url with comments and history lost.

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?

Purpose and return values are front-loaded, and the rendering guidance is dense but useful. However, the kind-immutability caveat appears twice (once mid-paragraph, once in the closing sentence) and largely restates the schema's own warning, which is mild redundancy in an otherwise tight block.

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?

Despite seven parameters, one required, and no output schema, the description covers return values, both document modes, rendering capabilities, and irreversible-state caveats. An agent has everything it needs to call this correctly and to warn its user before an irreversible choice.

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?

With only 43% schema description coverage, the description carries real weight: it explains kind's semantics and irreversibility, clarifies that markdown holds raw LaTeX under kind=latex, and says project/session/source_path record draft provenance for the dashboard. title and template are left to the schema, and template is already richly documented there, so the gap is minor.

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?

Opens with a specific verb and resource ('Create a review from markdown') and even names what it returns (the id and the review and feedback urls). The two modes (markdown vs latex) are clearly laid out, so an agent can distinguish this from list_reviews/get_review/update_source without opening any schema.

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 concrete decision rules: use kind="latex" when the body has \documentclass/\begin{document} or a .tex source_path, use ```mermaid for flows/decision trees/state machines, and attach images with attach_asset. It doesn't discuss when to create a new review versus updating an existing one via update_source, which is the one relevant alternative left unaddressed.

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