Skip to main content
Glama

Scaffold Academic Project

scaffold_academic_project

Initializes complete academic project folders and files for TCCs, dissertations, theses, or articles, creating chapters, figures, references, ABNT spec, and a main Typst, LaTeX, or Markdown file.

Instructions

Inicializa a árvore completa de diretórios e arquivos de um projeto acadêmico (TCC, Dissertação, Tese ou Artigo):

  • Cria diretórios capitulos/, figuras/, tabelas/, anexos/, apendices/ e .abnt-mcp/.

  • Se sample_pdf_path for fornecido, extrai automaticamente o padrão da universidade (cabeçalho da capa, preâmbulo, seções exigidas e brasão/logo da página 1).

  • Se logo_path for fornecido, copia o arquivo de logotipo para figuras/logo_instituicao.* e referencia-o na capa.

  • Gera abnt.spec.json, SPEC.md, referencias.bib e o arquivo principal (main.typ, main.tex ou main.md).

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_path": "<project_path>",
      "title": "<title>",
      "author": "<author>"
    },
    "name": "scaffold_academic_project"
  }
}

Input Schema

NameRequiredDescriptionDefault
cityNo
titleYes
authorYes
courseNo
formatNotypst
advisorNo
logo_pathNo
overwriteNo
institutionNo
project_pathYes
document_typeNotcc
sample_pdf_pathNo
research_problemNo
general_objectiveNo
methodology_summaryNo
specific_objectivesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.0
    • addedInput schema / properties / city
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations at all, the description must carry the behavioral burden, and it does disclose the concrete write side effects: which directories are created, which files are generated, and that a supplied sample_pdf_path triggers automatic university-pattern extraction from page 1. However it never explains what happens when project_path already exists, what the `overwrite` flag governs, or that existing files may be clobbered — a critical omission for a filesystem-mutating tool with zero annotation coverage.

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?

The description is front-loaded with the core action followed by a tight bullet list where each line adds a distinct fact (created dirs, PDF-derived pattern, logo handling, generated files). No filler, though the bullets could have been used to cover the undocumented required parameters instead.

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 explained, and the description adequately covers the structural side effects. But for a 16-parameter mutation tool with no annotations, the missing overwrite semantics, missing explanation of the three required fields, and missing guidance on the academic-metadata parameters leave real gaps for correct invocation.

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

Parameters2/5

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

Schema description coverage is 0% for 16 parameters, so the description must compensate, but it only explains two of them (sample_pdf_path and logo_path). The three required parameters (project_path, title, author) and the substantive metadata fields (research_problem, general_objective, methodology_summary, specific_objectives, institution, advisor, document_type, format, overwrite) receive no semantic explanation anywhere.

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?

The description names a specific verb and resource — initializing a complete directory tree and file set for an academic project — and enumerates the concrete artifacts produced (capitulos/, figuras/, abnt.spec.json, main.typ/.tex/.md). It does not explicitly contrast with the closest sibling (init_research_spec) or check_structure, so an agent must infer the boundary, but the purpose itself 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 Guidelines3/5

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

'Inicializa' implies this is a project-bootstrap action, which implies it belongs at the start of a workflow, but there is no explicit when-to-use/when-not-to-use statement, no mention of prerequisites, and no routing to init_research_spec or compile_tcc. Usage is only inferable from the verb.

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