Skip to main content
Glama

get_manuscript_outline_prompt

Generate a prompt for a detailed manuscript outline with section headers, word counts, key data points, and journal formatting notes. Ideal for research, reviews, and case reports.

Instructions

[FREE] Generate a prompt to create a detailed manuscript outline. Includes section headers, word counts, key data points, and journal formatting notes. Suitable for original research, reviews, and case reports.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
manuscript_typeYes
topicYes
journalYes
study_designYes
num_figures_tablesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • server.py:62-86 (handler)
    The @mcp.tool() decorated function that implements the get_manuscript_outline_prompt tool. It takes parameters (manuscript_type, topic, journal, study_design, num_figures_tables) and returns a formatted prompt string for creating a detailed manuscript outline.
    @mcp.tool()
    def get_manuscript_outline_prompt(
        manuscript_type: str,
        topic: str,
        journal: str,
        study_design: str,
        num_figures_tables: int = 3
    ) -> str:
        """
        [FREE] Generate a prompt to create a detailed manuscript outline.
        Includes section headers, word counts, key data points, and journal formatting notes.
        Suitable for original research, reviews, and case reports.
        """
        return f"""Create a detailed outline for a {manuscript_type} on {topic} for submission to {journal}.
    
    Include:
    - Suggested section headers and subheaders
    - Approximate word count per section
    - Key data/figures to include in each section
    - Notes on journal-specific formatting requirements if known
    
    Study type: {study_design}
    Number of figures/tables planned: {num_figures_tables}
    
    Structure the outline so it can be handed directly to a medical writer to begin drafting."""
  • server.py:971-971 (registration)
    The tool is registered in the list_all_tools() function as a free-tier tool with description 'Create a detailed manuscript outline with word counts'.
    ("get_manuscript_outline_prompt", "Create a detailed manuscript outline with word counts"),
  • The input schema is defined via the function signature: manuscript_type (str), topic (str), journal (str), study_design (str), num_figures_tables (int, default=3). The return type is str.
    def get_manuscript_outline_prompt(
        manuscript_type: str,
        topic: str,
        journal: str,
        study_design: str,
        num_figures_tables: int = 3
Behavior2/5

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

No annotations provided, so description must fully disclose behavior. It describes what the tool generates but does not indicate whether it is a one-time generation, if it requires special permissions, or what the output format is beyond 'a prompt'.

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 very concise, with three short sentences. It delivers the main action and key details without redundancy.

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?

Given the tool's complexity (5 parameters, 4 required) and lack of schema descriptions, the description provides only high-level output details. The existence of an output schema mitigates return-value concerns, but parameter guidance is missing.

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

Parameters1/5

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

Schema description coverage is 0%, and the description does not explain any of the five parameters (manuscript_type, topic, journal, etc.). It adds no meaning beyond the parameter names and types in the schema.

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 clearly states the tool generates a prompt for a detailed manuscript outline, specifying included elements (section headers, word counts) and suitable manuscript types. It distinguishes from siblings that focus on specific sections or other tasks.

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?

It explicitly states suitability for original research, reviews, and case reports, giving context for when to use. However, it does not mention when not to use or suggest alternatives from the sibling list.

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/pubspro/medwriter-mcp'

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