skill-researcher
- Repo stars 435
- Author updated Live
- Author repo nvim
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @benbrastmckie · no license declared
- Token usage
- Lean
- Setup complexity
- Guided setup
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Shell exec
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: skill-researcher
description: Conduct general research using web search, documentation, and codebase exploration. Invoke for g…
category: documentation
runtime: no special runtime
---
# skill-researcher output preview
## PART A: Task fit
- Use case: Conduct general research using web search, documentation, and codebase exploration. Invoke for general research tasks. Thin wrapper that delegates general research to general-research-agent subagent. runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Context References / Trigger Conditions / Execution Flow” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “Conduct general research using web search, documentation, and codebase exploration. Invoke for general research tasks. Thin wrapper that delegates general research to general-research-agent subagent. runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “Context References / Trigger Conditions / Execution Flow” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source mentions slash commands such as `/research`; use them first when your agent supports command triggers.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files, run shell commands.
Start with a small task and check whether the result follows “Context References / Trigger Conditions / Execution Flow”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: skill-researcher
description: Conduct general research using web search, documentation, and codebase exploration. Invoke for g…
category: documentation
source: benbrastmckie/nvim
---
# skill-researcher
## When to use
- Conduct general research using web search, documentation, and codebase exploration. Invoke for general research tasks.…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Context References / Trigger Conditions / Execution Flow” and keep inference separate from source facts.
- read files, write/modify files, run shell commands; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "skill-researcher" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Context References / Trigger Conditions / Execution Flow
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files, run shell commands | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} Researcher Skill
Thin wrapper that delegates general research to general-research-agent subagent.
IMPORTANT: This skill implements the skill-internal postflight pattern. After the subagent returns, this skill handles all postflight operations (status update, artifact linking, git commit) before returning. This eliminates the "continue" prompt issue between skill return and orchestrator.
Context References
Reference (do not load eagerly):
- Path:
.claude/context/formats/return-metadata-file.md- Metadata file schema - Path:
.claude/context/patterns/postflight-control.md- Marker file protocol - Path:
.claude/context/patterns/file-metadata-exchange.md- File I/O helpers - Path:
.claude/context/patterns/jq-escaping-workarounds.md- jq escaping patterns (Issue #1132)
Note: This skill is a thin wrapper with internal postflight. Context is loaded by the delegated agent.
Trigger Conditions
This skill activates when:
- Task type is "general", "meta", "markdown", "latex", or "typst"
- Research is needed for implementation planning
- Documentation or external resources need to be gathered
Execution Flow
Stage 1: Input Validation
Validate required inputs:
task_number- Must be provided and exist in state.jsonfocus_prompt- Optional focus for research direction
# Lookup task
task_data=$(jq -r --argjson num "$task_number" \
'.active_projects[] | select(.project_number == $num)' \
specs/state.json)
# Validate exists
if [ -z "$task_data" ]; then
return error "Task $task_number not found"
fi
# Extract fields
task_type=$(echo "$task_data" | jq -r '.task_type // "general"')
status=$(echo "$task_data" | jq -r '.status')
project_name=$(echo "$task_data" | jq -r '.project_name')
description=$(echo "$task_data" | jq -r '.description // ""')
Stage 2: Preflight Status Update
Update task status to "researching" BEFORE invoking subagent.
.claude/scripts/update-task-status.sh preflight "$task_number" research "$session_id"
This atomically updates state.json (status, timestamps, session_id), TODO.md task entry, and TODO.md Task Order section. If the script exits non-zero, abort and keep current status.
Stage 3: Create Postflight Marker
Create the marker file to prevent premature termination:
# Ensure task directory exists
padded_num=$(printf "%03d" "$task_number")
mkdir -p "specs/${padded_num}_${project_name}"
cat > "specs/${padded_num}_${project_name}/.postflight-pending" << EOF
{
"session_id": "${session_id}",
"skill": "skill-researcher",
"task_number": ${task_number},
"operation": "research",
"reason": "Postflight pending: status update, artifact linking, git commit",
"created": "$(date -u +%Y-%m-%dT%H:%M:%SZ)",
"stop_hook_active": false
}
EOF
Stage 3a: Read Artifact Number
Read next_artifact_number from state.json (or fall back to directory scanning for legacy tasks):
# Read next_artifact_number from state.json
artifact_number=$(jq -r --argjson num "$task_number" \
'.active_projects[] | select(.project_number == $num) | .next_artifact_number // 1' \
specs/state.json)
# Fallback for legacy tasks: count existing artifacts
if [ "$artifact_number" = "null" ] || [ -z "$artifact_number" ]; then
padded_num=$(printf "%03d" "$task_number")
count=$(ls "specs/${padded_num}_${project_name}/reports/"*[0-9][0-9]*.md 2>/dev/null | wc -l)
artifact_number=$((count + 1))
fi
artifact_padded=$(printf "%02d" "$artifact_number")
Stage 4a: Memory Retrieval (Auto)
Retrieve relevant memories from the memory system to inject into the delegation context.
Skip if: clean_flag is true in the delegation context (from --clean command flag).
# Check clean_flag
if [ "$clean_flag" != "true" ]; then
memory_context=$(bash .claude/scripts/memory-retrieve.sh "$description" "$task_type" "$focus_prompt" 2>/dev/null) || memory_context=""
fi
# memory_context will be empty string if:
# - clean_flag is true (skipped)
# - memory-index.json missing or empty
# - no keywords matched any entries
# - script exited with error
If memory_context is non-empty, it will be injected into the Stage 5 prompt alongside the format specification from Stage 4b. If empty, no memory block is injected.
Stage 4: Prepare Delegation Context
Prepare delegation context for the subagent:
{
"session_id": "sess_{timestamp}_{random}",
"delegation_depth": 1,
"delegation_path": ["orchestrator", "research", "skill-researcher"],
"timeout": 3600,
"task_context": {
"task_number": N,
"task_name": "{project_name}",
"description": "{description}",
"task_type": "{task_type}"
},
"artifact_number": "{artifact_number from Stage 3a}",
"focus_prompt": "{optional focus}",
"effort_flag": "{effort_flag from command, null if not set}",
"model_flag": "{model_flag from command, null if not set}",
"roadmap_path": "specs/ROADMAP.md",
"metadata_file_path": "specs/{NNN}_{SLUG}/.return-meta.json"
}
Note: The artifact_number field tells the agent which sequence number to use for artifact naming (e.g., 01, 02).
Model/Effort Flags: If model_flag is set (haiku, sonnet, opus), pass it as the model parameter on the Agent tool to override the agent's frontmatter default. If effort_flag is set (fast, hard), include it as prompt context for reasoning depth guidance.
Stage 4b: Read and Inject Format Specification
Read the report format file and prepare it for injection into the subagent prompt. This ensures the subagent always has the full format specification in its context, regardless of whether it reads the file itself.
format_content=$(cat .claude/context/formats/report-format.md)
The format content will be included as a delimited section in the Stage 5 prompt (see below).
Stage 5: Invoke Subagent
CRITICAL: You MUST use the Agent tool to spawn the subagent.
Required Tool Invocation:
Tool: Agent (NOT Skill, NOT Plan)
Parameters:
- subagent_type: "general-research-agent"
- prompt: [Include task_context, delegation_context, focus_prompt, metadata_file_path,
AND the format specification from Stage 4b as shown below]
- description: "Execute research for task {N}"
Format Injection: Include the format specification from Stage 4b in the prompt as a clearly-delimited section:
<artifact-format-specification>
## CRITICAL: Report Format Requirements
You MUST follow this format specification exactly when writing the research report.
Non-compliance will be caught by postflight validation.
{format_content from Stage 4b}
</artifact-format-specification>
Place this section AFTER the delegation context JSON and BEFORE any other instructions.
Memory Context Injection: If memory_context from Stage 4a is non-empty, include it in the prompt as a separate block:
{memory_context from Stage 4a -- already wrapped in <memory-context> tags}
Place the memory context block AFTER the format specification and BEFORE the task-specific instructions. Do NOT inject an empty <memory-context> block when no memories were retrieved.
DO NOT use Skill(general-research-agent) - this will FAIL.
The subagent will:
- Search codebase for related patterns
- Search web for documentation and examples
- Analyze findings and synthesize recommendations
- Create research report in
specs/{NNN}_{SLUG}/reports/ - Write metadata to
specs/{NNN}_{SLUG}/.return-meta.json - Return a brief text summary (NOT JSON)
Stage 5b: Self-Execution Fallback
CRITICAL: If you performed the work above WITHOUT using the Agent tool (i.e., you read files,
wrote artifacts, or updated metadata directly instead of spawning a subagent), you MUST write a
.return-meta.json file now before proceeding to postflight. Use the schema from
return-metadata-file.md with status value "researched" and the appropriate artifact information.
If you DID use the Agent tool (Stage 5), skip this stage -- the subagent already wrote the metadata.
Postflight (ALWAYS EXECUTE)
The following stages MUST execute after work is complete, whether the work was done by a subagent (Stage 5) or inline (Stage 5b). Do NOT skip these stages for any reason.
Stage 6: Parse Subagent Return (Read Metadata File)
Read the metadata file:
metadata_file="specs/${padded_num}_${project_name}/.return-meta.json"
if [ -f "$metadata_file" ] && jq empty "$metadata_file" 2>/dev/null; then
status=$(jq -r '.status' "$metadata_file")
artifact_path=$(jq -r '.artifacts[0].path // ""' "$metadata_file")
artifact_type=$(jq -r '.artifacts[0].type // ""' "$metadata_file")
artifact_summary=$(jq -r '.artifacts[0].summary // ""' "$metadata_file")
memory_candidates=$(jq -c '.memory_candidates // []' "$metadata_file")
else
echo "Error: Invalid or missing metadata file"
status="failed"
fi
Stage 6a: Validate Artifact Content
If subagent status is "researched" and artifact_path is non-empty, validate the report artifact against format requirements. This is non-blocking -- warnings are logged but do not prevent postflight from completing.
if [ "$status" = "researched" ] && [ -n "$artifact_path" ] && [ -f "$artifact_path" ]; then
echo "Validating report artifact..."
if ! bash .claude/scripts/validate-artifact.sh "$artifact_path" report --fix; then
echo "WARNING: Report artifact has format issues (non-blocking). Review output above."
fi
fi
Note: The --fix flag attempts auto-repair of missing metadata fields. Validation failures are logged but do not block status update or git commit.
Stage 7: Update Task Status (Postflight)
If status is "researched", update status and increment artifact number:
# Step 1: Update status (state.json, TODO.md task entry, TODO.md Task Order)
if [ "$status" = "researched" ]; then
.claude/scripts/update-task-status.sh postflight "$task_number" research "$session_id"
fi
# Step 2: Increment next_artifact_number (research advances the sequence)
jq '(.active_projects[] | select(.project_number == '$task_number')).next_artifact_number =
(((.active_projects[] | select(.project_number == '$task_number')).next_artifact_number // 1) + 1)' \
specs/state.json > specs/tmp/state.json && mv specs/tmp/state.json specs/state.json
Note: Research is the only operation that increments next_artifact_number. Plan and implement use (current - 1) to stay in the same "round".
On partial/failed: Keep status as "researching" for resume (do not call the script).
Stage 7a: Propagate Memory Candidates
If the agent emitted memory candidates, append them to the task's state.json entry using append semantics (merge with any existing candidates from prior operations).
if [ "$memory_candidates" != "[]" ] && [ -n "$memory_candidates" ]; then
# Append new candidates to existing array (append semantics, not overwrite)
jq --argjson new_candidates "$memory_candidates" \
'(.active_projects[] | select(.project_number == '$task_number')).memory_candidates =
((.active_projects[] | select(.project_number == '$task_number')).memory_candidates // []) + $new_candidates' \
specs/state.json > specs/tmp/state.json && mv specs/tmp/state.json specs/state.json
fi
Note: Uses // [] fallback so this works whether or not the task already has candidates. Append semantics ensure research and implementation candidates coexist.
Stage 8: Link Artifacts
Add artifact to state.json with summary.
IMPORTANT: Use two-step jq pattern to avoid Issue #1132 escaping bug. See jq-escaping-workarounds.md.
if [ -n "$artifact_path" ]; then
# Step 1: Filter out existing research artifacts (use "| not" pattern to avoid != escaping - Issue #1132)
jq '(.active_projects[] | select(.project_number == '$task_number')).artifacts =
[(.active_projects[] | select(.project_number == '$task_number')).artifacts // [] | .[] | select(.type == "research" | not)]' \
specs/state.json > specs/tmp/state.json && mv specs/tmp/state.json specs/state.json
# Step 2: Add new research artifact
jq --arg path "$artifact_path" \
--arg type "$artifact_type" \
--arg summary "$artifact_summary" \
'(.active_projects[] | select(.project_number == '$task_number')).artifacts += [{"path": $path, "type": $type, "summary": $summary}]' \
specs/state.json > specs/tmp/state.json && mv specs/tmp/state.json specs/state.json
fi
Link artifact in TODO.md: Use the link-artifact-todo.sh script (REQUIRED -- do NOT manually edit artifact links in TODO.md):
bash .claude/scripts/link-artifact-todo.sh $task_number '**Research**' '**Plan**' "$artifact_path"
The script produces bracket-only [path] format. Never use markdown [name](path) format for artifact links. If the script exits non-zero, log a warning but continue (linking errors are non-blocking).
Stage 8a: Lifecycle TTS Notification
Fire TTS and WezTerm tab coloring after artifact linking is complete:
lifecycle_script=".claude/scripts/lifecycle-notify.sh"
if [ -f "$lifecycle_script" ]; then
bash "$lifecycle_script" "$STATE_STATUS" &
fi
Non-blocking: called in background after artifacts are linked. Speaks "Tab N STATUS" (e.g., "Tab 3 researched") to announce the lifecycle transition.
Stage 9: Cleanup
Remove marker and metadata files:
rm -f "specs/${padded_num}_${project_name}/.postflight-pending"
rm -f "specs/${padded_num}_${project_name}/.postflight-loop-guard"
rm -f "specs/${padded_num}_${project_name}/.return-meta.json"
Stage 10: Return Brief Summary
Return a brief text summary (NOT JSON). Example:
Research completed for task {N}:
- Found {count} relevant patterns and resources
- Identified implementation approach: {approach}
- Created report at specs/{NNN}_{SLUG}/reports/MM_{short-slug}.md
- Status updated to [RESEARCHED]
Error Handling
Input Validation Errors
Return immediately with error message if task not found.
Metadata File Missing
If subagent didn't write metadata file:
- Keep status as "researching"
- Do not cleanup postflight marker
- Report error to user
Subagent Timeout
Return partial status if subagent times out (default 3600s). Keep status as "researching" for resume.
MUST NOT (Postflight Boundary)
After the agent returns, this skill MUST NOT:
- Edit source files - All research work is done by agent
- Run build/test commands - Verification is done by agent
- Use MCP/WebSearch tools - Research tools are for agent use only
- Analyze or grep source - Analysis is agent work
- Write reports - Artifact creation is agent work
The postflight phase is LIMITED TO:
- Reading agent metadata file
- Calling
update-task-status.shfor status updates (state.json + TODO.md) - Incrementing
next_artifact_numbervia jq - Linking artifacts in state.json
- Cleanup of temp/marker files
Reference: @.claude/context/standards/postflight-tool-restrictions.md
Return Format
This skill returns a brief text summary (NOT JSON). The JSON metadata is written to the file and processed internally.
Example successful return:
Research completed for task 412:
- Found 8 relevant patterns for implementation
- Identified lazy context loading and skill-to-agent mapping patterns
- Created report at specs/412_general_research/reports/MM_{short-slug}.md
- Status updated to [RESEARCHED]
Example partial return:
Research partially completed for task 412:
- Found 4 codebase patterns
- Web search failed due to network error
- Partial report created at specs/412_general_research/reports/MM_{short-slug}.md
- Status remains [RESEARCHING] - run /research 412 to continue
Decide Fit First
Design Intent
How To Use It
Boundaries And Review