Skip to main content
Glama

Init Research Spec

init_research_spec

Creates the abnt.spec.json and SPEC.md scientific specification manifest for a research project, defining 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.

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>",
      "research_problem": "<research_problem>",
      "general_objective": "<general_objective>",
      "specific_objectives": "<specific_objectives>",
      "methodology_summary": "<methodology_summary>"
    },
    "name": "init_research_spec"
  }
}

Input Schema

NameRequiredDescriptionDefault
cityNo
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. 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

C2.9/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral burden. It usefully discloses that the tool creates two named files, copies a logo, and performs automatic learning from a model PDF, but it does not state whether existing files are overwritten, what permissions are required, or how failures are handled.

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 and then uses a clean three-layer bullet structure to explain the generated artifacts. It is appropriately sized and free of obvious filler, though the layer bullets stop short of resolving the largest practical ambiguities.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex initialization tool with 16 parameters, no annotations, and no parameter descriptions, the description is not complete enough. Output schema coverage helps with return values, but the description still lacks usage boundaries, overwrite behavior, and parameter-to-artifact mapping that an agent would need to call it confidently.

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% across 16 parameters, so the description must compensate. It provides some semantic grouping for research fields such as problem, general objective, specific objectives, and planned chapters, but it does not explain most parameters, including project_path, title, author, advisor, document_type, or methodology_summary.

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 gives a specific verb and resources: it initializes 'abnt.spec.json' and 'SPEC.md' in the project, and it outlines the three content layers. It is clear what the tool creates, but it does not explicitly distinguish itself from siblings such as audit_research_spec or scaffold_academic_project.

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?

The description explains what the tool does but gives no explicit guidance on when to use it versus alternatives. 'Inicializa' implies a project-start context, but there are no exclusions, prerequisites, or references to sibling tools that would help an agent choose correctly.

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