Skip to main content
Glama

Consulter le plan

get_academic_outline
Read-onlyIdempotent

Retrieve the current project outline with each section’s status to track writing progress and identify unfinished parts of an academic document.

Instructions

Renvoie le plan actuel du projet avec l'état de chaque section.

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": {
      "project_id": "<project_id>"
    },
    "name": "get_academic_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idYes

Output Schema

NameRequiredDescriptionDefault
idYes
statusYes
versionYes
languageYes
sectionsYes
domain_idYes
conventionYes
created_atYes
project_idYes
approved_atNo
target_wordsYes
global_requirement_idsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description adds that the payload includes per-section status, which is genuine content-level context, but says nothing about ordering, size, or behavior for a missing/invalid project.

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?

A single front-loaded sentence with zero filler. It is efficient, though its brevity is what leaves the gaps in usage and parameter detail rather than any padding problem.

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?

An output schema exists, so return values need not be described, and annotations cover the read-only profile. For a simple one-parameter getter this is nearly adequate, but the absence of any routing guidance among many get_* siblings leaves a real gap.

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 0%, so the description must carry parameter meaning. The phrase "du projet" makes clear that project_id selects the project whose outline is returned, which is the essential semantics, but no format, source, or validation detail is added.

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 resource: "Renvoie le plan actuel du projet" plus the returned content ("l'état de chaque section"). The read semantics are clear enough to separate it from create_academic_outline and edit_academic_outline, but those siblings are never named, so differentiation is inferred from the verb alone.

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?

There is no when-to-use or when-not-to-use guidance, and no alternative is mentioned. An agent must guess whether to call this or a sibling such as get_document_structure_template or get_project when it needs outline information.

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

Deploy Server

Other Tools