Skip to main content
Glama

Init Research Spec

init_research_spec

Initializes the scientific specification manifest (abnt.spec.json and SPEC.md) for a research project, covering normative profile, traceable objectives, and planned chapter targets.

Instructions

Inicializa o manifesto de Especificação Científica (SDD) 'abnt.spec.json' e 'SPEC.md' no projeto:

  • Camada 1: Perfil Normativo e Institucional (com aprendizado automático de PDF modelo da faculdade e cópia de logo).

  • Camada 2: Matriz Científica rastreável (Problema, Objetivo Geral e Objetivos Específicos OBJ-XX).

  • Camada 3: Capítulos planejados com metas mínimas de extensão e citações.

Input Schema

NameRequiredDescriptionDefault
titleYes
authorNo
courseNo
advisorNo
logo_pathNo
institutionNo
project_pathYes
document_typeNotcc
min_referencesNo
sample_pdf_pathNo
planned_chaptersNo
research_problemYes
general_objectiveYes
methodology_summaryYes
specific_objectivesYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

Sem anotações, a descrição carrega toda a responsabilidade e, de fato, informa os efeitos colaterais relevantes: criação de dois arquivos, cópia do logo e aprendizado automático a partir do PDF modelo. Faltam as semânticas de idempotência: se sobrescreve um spec existente, se falha ou se faz merge.

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?

O núcleo (inicializar os arquivos no projeto) vem primeiro, e as três camadas em bullets organizam bem o conteúdo. Há alguma densidade de jargão interno ('SDD', 'Camada 1/2/3'), mas a extensão é proporcional às informações fornecidas.

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?

Há output schema, portanto não é preciso descrever o retorno, e as camadas dão uma boa ideia do conteúdo gerado. Ainda assim, para uma ferramenta de escrita com 15 parâmetros, sem anotações e com cobertura de schema nula, faltam detalhes sobre sobrescrita, permissões e formato dos dados esperados, o que limita a completude.

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?

Com 15 parâmetros e 0% de cobertura no schema, a descrição deveria compensar, mas só aborda `research_problem`, `general_objective`, `specific_objectives` (OBJ-XX), `planned_chapters`, `sample_pdf_path` e `logo_path`. `project_path`, `author`, `course`, `advisor`, `institution`, `document_type`, `min_references` e `methodology_summary` não são explicados.

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?

A descrição começa com um verbo específico ('Inicializa') e um recurso concreto (o manifesto de Especificação Científica), além de nomear os artefatos gerados ('abnt.spec.json' e 'SPEC.md'). Isso a distingue implicitamente de `audit_research_spec`, que audita o mesmo artefato, embora a diferenciação não seja explicada com palavras.

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?

Não há indicação explícita de quando usar esta ferramenta, de quando não usar nem de pré-requisitos, como a necessidade de o projeto já existir. A sobreposição com `scaffold_academic_project` (que também cria estrutura de projeto) não é resolvida.

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