Skip to main content
Glama

Reporting checklist for a design

lnm_methods_checklist
Read-onlyIdempotent

Return a tickable reporting checklist for your study design, grading each item as required, expected, or optional with reasons. Use it while drafting Methods and before submission to cover all essentials.

Instructions

Return the reporting checklist for a design as a tickable table.

Items are graded: 'required' means a reviewer of this design will ask for it by name, 'expected' means its absence reads as carelessness, 'optional' means it strengthens the paper. Each item carries the reason it matters, so you can decide rather than comply.

Use while drafting the Methods, and again before submission. For a check against finished text instead of a list to work from, use lnm_audit_manuscript.

Args:

  • design: optional design id; omitted returns items common to every design

  • section: optional, e.g. 'Methods', 'Results', 'Discussion'

  • include_optional: default false

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
designNoDesign id; omit for the design-independent core.
sectionNoRestrict to one section, e.g. 'Methods'.
response_formatNoOutput format: 'markdown' to read, 'json' for machine processing.markdown
include_optionalNoInclude items graded 'optional'.
Install Server

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so no contradiction exists. The description adds meaningful behavioral context beyond those hints: items are graded 'required', 'expected', or 'optional', each item carries its rationale, and the checklist is meant for drafting rather than exhaustive auditing.

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 well-structured and front-loaded: a one-line purpose, a compact explanation of grading semantics, explicit usage timing, a sibling alternative, and a clearly formatted Args list. Every sentence adds value without padding.

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?

The description is complete for a read-only checklist tool: it explains what is returned, how items are graded, when to use it, when not to use it, and what each parameter does. Although there is no output schema, the 'tickable table' and item-grading description cover the key output expectations.

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 100%, so the baseline is 3, but the description adds useful meaning: it explains that omitting design returns items common to every design, that section restricts to a section, and that include_optional controls optional-item inclusion. The only minor gap is that response_format is not mentioned in the Args list, though the schema documents it fully.

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?

The description opens with a specific verb and resource: 'Return the reporting checklist for a design as a tickable table.' It clearly distinguishes the tool from its sibling lnm_audit_manuscript by contrasting a working list with a check against finished text, so an agent can tell them apart.

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

Usage Guidelines5/5

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

The description explicitly states when to use the tool ('Use while drafting the Methods, and again before submission') and names the alternative for a different task ('For a check against finished text instead of a list to work from, use lnm_audit_manuscript'). This gives the agent actionable routing guidance.

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

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/nielspac177/lnm-writer'

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