convez.ai
SkillAutomaçãoAvançado
LARi-UQAC

ResearchTools — Suite para Pesquisa Acadêmica

LARi-UQAC/ResearchTools

Automação completa de pesquisa acadêmica: LaTeX, Scopus, auditoria e templates

Ver no GitHub
InicialPluginScore · de 0 a 100

Conjunto de 5 skills, 11 agents e 17 comandos para automatizar tarefas de pesquisa acadêmica em LaTeX, validação de referências Scopus, auditoria de papers/teses e conversão de templates de bolsa. Integra-se nativamente com Claude Code e suporta fluxos de escrita científica end-to-end.

Instalação

$npx convez-ai LARi-UQAC/ResearchTools

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
15
Forks
2
Acompanhando
0
Saúde
42%
Último commit
há 2 dias
Versão
v0.3.0
Issues abertas
22
Contribuidores
1

Casos de uso

  • Validar e limpar bibliografias usando a API Scopus
  • Converter documentos Word para LaTeX automaticamente
  • Auditar papers e teses com checklist e cross-review
  • Gerar respostas a revisores e revisões literárias estruturadas
  • Integrar com vault Obsidian para gerenciamento de pesquisa

Veredito

Ferramenta robusta e bem-arquitetada para pesquisadores que trabalham com LaTeX e Scopus. Requer configuração local (chaves API, Python, Node.js, pandoc) e é voltada para fluxos acadêmicos específicos; não é plug-and-play, mas oferece ganho significativo de produtividade em escrita científica.

README

A tradução para o português deste README ainda está na fila.

ResearchTools — Manual

Reference for the skills, agents and commands shipped in this repository. Everything documented here lives under .claude/ in this repo (academic research tooling for LaTeX writing, Scopus reference validation, paper/thesis auditing, and grant-template conversion). For a map of how the pieces relate, see Architecture.md.

The repo ships 5 skills, 11 agents, and 17 commands.


Installation

Follow these steps on any machine after cloning the repository.

Prerequisites

ToolRequired for
Claude CodeRunning agents and slash commands
Git for Windows (includes Git Bash)Hooks that use bash shell
Node.jsCaveman-mode hooks (caveman-activate.js, etc.)
Python 3.xScopus skill scripts + security hooks (betterleaks, pip-audit, prompt-injection-defender)
pip install requests google-genai openaiScopus skill + Gemini/Copilot cross-review
pandocword2latex skill (Word → LaTeX)
Obsidian Desktop (optional)Obsidian vault integration in CLAUDE.md

Step 1 — Clone the repository

git clone https://github.com/LARi-UQAC/ResearchTools.git
cd ResearchTools

Step 2 — Generate machine-local configuration

Run the setup script from the repository root. It auto-detects Git Bash and Node.js, asks for your Obsidian vault path (optional), and generates two gitignored files: .claude/settings.json and CLAUDE.md.

.\setup.ps1

Verify that no {{placeholder}} remains after the script completes — it reports any unreplaced values in the validation step.

Step 3 — Make agents available globally (optional, recommended)

This step creates directory junctions from ~/.claude/agents/, ~/.claude/skills/, ~/.claude/rules/, and ~/.claude/commands/ into this repository, so that Claude Code loads these agents and skills in every workspace, not only when you open this folder.

Requires Administrator privileges.

# Review what will be created without making changes
.\install-junctions.ps1 -WhatIf

# Apply
.\install-junctions.ps1

Because the links point directly into this repository, a git pull is all that is needed to propagate improvements contributed by any collaborator.

Contributing improvements

Fork the repository, improve an agent or skill on a feature branch, and open a pull request against main. The repository owner reviews and merges; a git pull on their machine immediately updates the linked entries via the junctions.


Environment variables / API keys

Set these at the Windows User scope (PowerShell), then restart Claude Code:

[System.Environment]::SetEnvironmentVariable('SCOPUS_API_KEY', 'your-key', 'User')
Variable / sourceRequired forWhere to get it
SCOPUS_API_KEYRequired — all /scopus, /auditreview, /auditpaper, /auditthesis, /litreview, /bibclean, /replyreviewer, and PDF retrievalElsevier Developer Portal
.scopus_key fileFallback for SCOPUS_API_KEY — place the key in .claude/skills/scopus/.scopus_key (gitignored)same key as above
GEMINI_API_KEYOptional — Gemini 2.0 Flash cross-review and table enrichment (deliberation panel)Google AI Studio
GITHUB_TOKENOptional — GPT-4o cross-review via GitHub Models (deliberation panel)GitHub → Settings → Developer settings → Personal access token
S2_API_KEY (or SEMANTIC_SCHOLAR_API_KEY)Optional — Semantic Scholar author/PDF backfill; without it the throttled public pool is usedSemantic Scholar API key request
--insttoken (CLI flag, not an env var)Optional — off-campus Elsevier access when not on the UQAC network/VPNUQAC library / Elsevier institutional token

An on-campus network connection or active UQAC VPN is required for Scopus access unless an --insttoken is supplied. Secrets are kept out of git: .env, secrets/, and credentials/ are listed in .gitignore.


Token Management

Use these tools together to keep sessions fast and cheap.

Output modes

ModeCommandMax lengthFormatting
Normal(none)UnlimitedFull — headers, tables, bullets
Concise/concis5 sentencesStructured bullets allowed
Slim/slim2 sentencesCode blocks only, no prose

Recommended workflow

  1. Start every session with /slim (quick tasks) or /concis (exploratory work)
  2. Scope context with /focus <topic> to avoid loading irrelevant files
  3. Monitor with /ctx when responses feel slow — it reports context pressure in under 10 lines
  4. Compress with /compact when /ctx reports moderate or high pressure

/compact is destructive — conversation history is summarized and cannot be restored. Always run /ctx first to confirm it is needed.

Quick reference

CommandWhen to use
/slimFast edits, one-liners, quick questions
/concisCode reviews, multi-step explanations
/focus <topic>Long sessions touching many files
/ctxWhen the session feels sluggish or heavy
/compactAfter /ctx reports moderate/high pressure

Skills

Skills bundle scripts and references the agents reuse. Five ship in this repo.

SkillPurposeEntry point
scopusSearch Scopus, validate references, fetch PDFs via the Elsevier REST API (with a Semantic Scholar fallback)./scopus, .claude/skills/scopus/SKILL.md
scientific-writingCore writing skill: scientific manuscripts in flowing IMRAD prose with verified citations (IEEE/APA/AMA/Vancouver) and reporting guidelines (CONSORT/STROBE/PRISMA)..claude/skills/scientific-writing/SKILL.md
scholar-evaluationScholarEval framework — scores research work across problem formulation, literature review, methodology, data, analysis, results, writing, citations..claude/skills/scholar-evaluation/SKILL.md
deliberationTwo-round Gemini ↔ GitHub Copilot debate over a near-final draft; Claude arbitrates and validates any new references against Scopus. Used inside the auditor/researcher agents..claude/skills/deliberation/SKILL.md
word2latexConvert a Word .docx template (Mitacs, CRSNG, FRQNT, UQAC, partner forms) into a faithful LaTeX source. Delegates the patch work to the word-to-latex agent./word2latex, .claude/skills/word2latex/SKILL.md

/scopus — Scopus academic search

Searches the Scopus database via the Elsevier REST API. Requires SCOPUS_API_KEY (see the API-keys table above) and an active institutional network connection (campus or VPN), or an --insttoken.

CommandWhat it does
/scopus <topic>Search top papers on a topic
/scopus review <topic>Structured literature review with inline citations
/scopus validate <DOI or title>Confirm a reference exists and return full metadata
/scopus cite <DOI>Citation count + full metadata for one paper
/scopus author <name>Author h-index and top publications
/scopus journal <name or ISSN>Journal SJR quartile, CiteScore, subject areas

Files:

  • .claude/skills/scopus/SKILL.md
  • .claude/skills/scopus/scripts/scopus_api.py — Scopus REST client
  • .claude/skills/scopus/scripts/semantic_scholar_api.py — Semantic Scholar fallback
  • .claude/skills/scopus/scripts/download_pdf.py — full-text PDF retrieval
  • .claude/skills/scopus/scripts/gemini_reviewer.py · github_reviewer.py · gemini_table.py — cross-review cores

Commands (Slash Commands)

Invoked with /command-name [arguments] in any Claude Code session. All files live in .claude/commands/.

CommandWhat it doesArguments
/concisConcise mode for the rest of the sessionNo
/slimSlim mode — ultra-minimal output (2 sentences, code only)No
/focus <topic>Scopes the session to one topic onlyYes — topic
/ctxAudits context-window pressure (turns, topics, recommendation)No
/tikz [code]Validates TiKZ code against 6 rules (anchoring, arrows, overlaps…)Optional — code or file
/test [module]Runs project tests following .claude/rules/testing.mdOptional — module/file
/doc <target>Generates or updates documentation for a file or functionYes — file/function
/latex [args]Diagnoses and fixes LaTeX errors from the .log or open fileOptional — specific error
/ref <citation>Formats and validates an academic reference (UQAC/LAR.i style)Yes — reference
/litreview <topic>Full autonomous literature review: search → validate → synthesize → comparison table → hypotheses + contributions → objectives → context → novelty checklistYes — research topic
/auditreview [file or text]Audit an existing review: validate references, flag errors, novelty checklist, executable improvement planOptional — file/text/IDE file
/auditpaper [file or text]Audit a complete paper: references, methodology, results, discussion, future works — Scopus validation + cross-review + improvement planOptional — file/text/IDE file
/auditthesis [main.tex or dir]Full UQAC thesis audit: front matter, jury, hypothesis flow, chapter structure, references, figures, equations, acronyms, LLM-style, bilingual résumé/abstract, UQAC formattingOptional — path/dir/IDE file
/bibclean [file.bib]Clean and validate a BibTeX file: required fields, author normalization, duplicates, DOI enrichment, SJR quartile, publisher approval checkOptional — .bib file/IDE file
/submitcheck <file.tex> <journal>Check submission readiness for a target journal: page count, sections, reference style, abstract length, keywords, anonymizationYes — .tex file + journal
/replyreviewerPoint-by-point LaTeX response letters + track-change markup in the paper via the changes package (one letter per reviewer file)Yes — see below
/word2latexConvert a Word .docx template to a faithful LaTeX source (pandoc + standard patch sequence)Yes — .docx path

/concis — Concise mode

Activates for the rest of the session: max 5 sentences for short answers, structured bullets for long answers, no preamble, no trailing summary, code written directly with WHY-only comments. Responds in French unless the active file is in English.

File: .claude/commands/concis.md

/focus <topic> — Session scope

Restricts the session to a single topic; everything outside it is ignored. Responds in French unless the active file is in English.

File: .claude/commands/focus.md

/ctx — Context window audit

Reports, in under 10 lines: estimated exchange turns, top 3 context-consuming topics/files, a low/moderate/high pressure level, and a /compact recommendation when needed. Reads no additional files. Responds in French.

File: .claude/commands/ctx.md

/tikz — TiKZ validation

Validates TiKZ code (from $ARGUMENTS or the IDE file) against 6 rules:

RuleWhat is checked
Line breaks in nodesalign=center only — never text centered
backgrounds + scalingNo \begin{scope}[on background layer] inside \resizebox/\scalebox
Arrow anglesArrows connect perpendicularly to node borders (.north/.south/.east/.west)
OverlapsMin 3-character gap between rectangles; arrow labels must not overlap geometry
Anchoringpositioning library + node distance only — no absolute coordinates
TiKZiT compatibilityNamed styles in .tikzstyles; no exotic libraries

For each violation: cites the line, explains the cause, provides corrected code directly.

File: .claude/commands/tikz.md

/test [module] — Run project tests

Reads .claude/rules/testing.md, selects the correct venv, runs the tests, and reports passed / total with short error messages and likely causes.

File: .claude/commands/test.md

/doc <target> — Documentation generator

Generates documentation following .claude/rules/code-style.md (Python Stage-N module + Purpose/Inputs/Outputs docstrings; C# /// <summary>; LaTeX/Markdown equation formatting). Documents WHY, not WHAT. Responds in French unless the active file is in English.

File: .claude/commands/doc.md

/latex — LaTeX diagnosis and fix

Reads out/*.log first for exact error lines, cites the line, explains the cause, and applies the fix directly. Priority checks: \resizebox wrapping a backgrounds-library tikzpicture, \\ in a text centered node, \addcontentsline order. States whether a two-pass recompilation is needed. Responds in French.

File: .claude/commands/latex.md

/ref <citation> — Academic reference formatter

Formats and validates references per UQAC / LAR.i rules.

Accepted publishers: IEEE, Springer, Elsevier, Taylor & Francis, Cambridge, Wiley, IET, IOP, ACM, MDPI, ASME, ACME, BioMed Central (BMC). Any other publisher requires professor approval. Provides: full LaTeX reference, clickable DOI via \href, a 0–100 % confidence level with justification, and an introductory sentence. Never fabricates a reference or DOI.

File: .claude/commands/ref.md

/replyreviewer — Peer reviewer response generator

Generates a formal LaTeX response letter per reviewer comment file and applies track-change markup directly in the paper using the changes package. The reviewer ID (id=RN) in each \added, \replaced, or \deleted command is the permanent, visible link between the paper modification and the response letter. Delegates to the reviewer-response agent.

Full command syntax:

/replyreviewer --paper <paper.tex> --reviewers <r1.txt> [r2.txt ...] [--title "Title"] [--editor "Name"]

Example:

/replyreviewer --paper sn-article.tex --reviewers .\reviewers\R1.txt .\reviewers\R2.txt --editor "Zhouping Yin"
ArgumentRequiredDescription
--paper <path.tex>YesPath to the original LaTeX paper
--reviewers <files>YesOne .txt file per reviewer; first = R1, second = R2, etc.
--title "..."NoPaper title for the letter header; extracted from \title{} if omitted
--editor "..."NoEditor name for the salutation; defaults to [EDITOR NAME] if omitted

What the agent produces:

  1. One LaTeX response letter per reviewer — <basename>_response_R<N>.tex, each with a formal opening, General Comments, point-by-point Specific Comments, and a Scopus-validated References Added section with clickable DOIs.
  2. Annotated original paper — \added[id=RN]{} / \replaced[id=RN]{}{} / \deleted[id=RN]{} markup, grammar-only fixes applied directly, and \usepackage{changes} with one \definechangesauthor per reviewer (R1 blue, R2 red, R3 orange, R4+ purple) added to the preamble automatically.

Comment categories processed:

CodeCategoryPaper change
GGrammar / spellingDirect fix, no markup
SStyle / writing\replaced[id=RN]{new}{old}
SCScientific issue\added[id=RN]{...}
MMethodology addition\added[id=RN]{...}
RResults addition\added[id=RN]{...}
DDiscussion addition\added[id=RN]{...}
FTFigure / table issue\added[id=RN]{...} new float
EQEquation issue\replaced[id=RN]{}{} or \deleted[id=RN]{}
REFReference suggestionScopus-validated, \added[id=RN]{\cite{}}
QGeneral quality\added[id=RN]{...}
MAJMajor revision\replaced[id=RN]{}{} / \deleted[id=RN]{}

Prerequisites: SCOPUS_API_KEY set; campus network or VPN active.

Related commands: /auditpaper (full audit before/after revision), /bibclean (clean the .bib after adding references), /ref (format individual references).

File: .claude/commands/replyreviewer.md


Agents

Agents are specialists Claude delegates to automatically based on context, or explicitly on request ("use the scopus-auditor agent to…"). Eleven ship in this repo; most back a slash command.

AgentPurposeCommand / triggerPath
scopus-researcherAutonomous literature review: search, validate, summarize, PRISMA + gap/coverage/Pareto matrices, hypotheses, LaTeX output/litreview.claude/agents/scopus-researcher/AGENT.md
scopus-auditorAudit an existing review; validate every reference; executable improvement plan/auditreview.claude/agents/scopus-auditor/AGENT.md
paper-auditorFull paper content audit (intro→future works) + Scopus validation + ScholarEval score + improvement plan/auditpaper.claude/agents/paper-auditor/AGENT.md
thesis-auditorFull UQAC thesis audit (front matter, hypothesis flow, chapter structure, bilingual consistency, UQAC compliance)/auditthesis.claude/agents/thesis-auditor/AGENT.md
thesis-proposal-auditorAudit a UQAC thesis proposal (≤35 pages body, testable hypotheses, suggested methodology, no full results)thesis-proposal audit / by name.claude/agents/thesis-proposal-auditor/AGENT.md
reviewer-responsePoint-by-point response letters + traceable changes-package markup in the paper/replyreviewer.claude/agents/reviewer-response/AGENT.md
bib-cleanerValidate, deduplicate, normalize and DOI-enrich a .bib file/bibclean.claude/agents/bib-cleaner/AGENT.md
submit-checkerPass/fail submission checklist against a target journal's requirements/submitcheck.claude/agents/submit-checker/AGENT.md
word-to-latexFaithful Word .docx → LaTeX conversion (pandoc + visual-fidelity patches)/word2latex.claude/agents/word-to-latex/AGENT.md
cover-paperSubmission package: hidden Cover Letter in source, standalone Title Page PDF, Corresponding Author Profile PDF (recent papers from Scopus)by name (at submission).claude/agents/cover-paper/AGENT.md
latex-writerBilingual LaTeX authoring: papers (IEEE/Springer/Elsevier), Beamer slides, TiKZ diagrams, thesisby context (writing).claude/agents/latex-writer/AGENT.md

latex-writer key rules

  • TiKZ: relative positioning only; arrows perpendicular; no overlaps
  • References: peer-reviewed only (IEEE, Springer, Elsevier, Taylor & Francis, Cambridge, Wiley, IET, IOP, ACM, MDPI, ASME, ACME, BioMed Central (BMC)); DOI via hyperref; any other publisher needs user confirmation
  • Tables: rows = parameters, cols = concepts; bold headers; 10 % grey row shading
  • Language: French default for UQAC thesis, English for scientific papers
  • Avoid AI-detectable patterns: zero-width spaces, smart quotes, em dashes, perfect parallel lists

reviewer-response key rules

  • Reviewer files assigned sequentially: first file = R1, second = R2, etc.
  • Grammar-only fixes (G): applied directly, no markup
  • Additions \added[id=RN]{}, deletions \deleted[id=RN]{}, rewrites \replaced[id=RN]{}{} (changes package)
  • Reviewer colors: R1 blue, R2 red, R3 orange, R4+ purple (\definechangesauthor)
  • Every proposed reference validated via Scopus; [NO DOI] flagged in the summary when applicable

Calling an agent explicitly

Agents are normally triggered automatically by context. To invoke one directly, address it by name in your message:

Use the scopus-auditor agent to audit the review in paper_review/literature_review.tex
reviewer-response agent: --paper sn-article.tex --reviewers r1.txt --editor "Prof. Yin"

The slash commands /auditreview, /replyreviewer, /litreview, etc. are thin wrappers that call these agents with the same argument syntax — use the commands for convenience and the explicit agent names when you need finer control or want to chain agents in one message.


File Locations Summary

All agents, commands, and skills live under this repository's .claude/ directory.

ResearchTools\
└── .claude\
    ├── agents\                              (11 agents)
    │   ├── scopus-researcher\AGENT.md       ← /litreview
    │   ├── scopus-auditor\AGENT.md          ← /auditreview
    │   ├── paper-auditor\AGENT.md           ← /auditpaper
    │   ├── thesis-auditor\AGENT.md          ← /auditthesis
    │   ├── thesis-proposal-auditor\AGENT.md ← thesis-proposal audit
    │   ├── reviewer-response\AGENT.md       ← /replyreviewer
    │   ├── bib-cleaner\AGENT.md             ← /bibclean
    │   ├── submit-checker\AGENT.md          ← /submitcheck
    │   ├── word-to-latex\AGENT.md           ← /word2latex
    │   ├── cover-paper\AGENT.md             ← submission package
    │   └── latex-writer\AGENT.md            ← LaTeX authoring
    ├── commands\                            (17 commands)
    │   ├── concis.md   ├── slim.md    ├── focus.md   ├── ctx.md
    │   ├── tikz.md     ├── test.md    ├── doc.md     ├── latex.md
    │   ├── ref.md      ├── litreview.md             ├── auditreview.md
    │   ├── auditpaper.md               ├── auditthesis.md
    │   ├── bibclean.md ├── submitcheck.md           ├── replyreviewer.md
    │   └── word2latex.md
    ├── rules\                               (code-style, preferences, security, testing, workflows)
    └── skills\                              (5 skills)
        ├── scopus\
        │   ├── SKILL.md
        │   └── scripts\  (scopus_api.py, semantic_scholar_api.py, download_pdf.py,
        │                  gemini_reviewer.py, github_reviewer.py, gemini_table.py)
        ├── scientific-writing\SKILL.md
        ├── scholar-evaluation\SKILL.md      (+ scripts\calculate_scores.py)
        ├── deliberation\SKILL.md            (+ scripts\deliberate.py)
        └── word2latex\SKILL.md              (+ scripts\docx_inspect.py, manuscript_bib.py)
Ver o original no GitHub

Bom para

Relacionados