Agent skill

ralph-specum-index

This skill should be used only when the user explicitly asks to use `$ralph-specum-index`, or explicitly asks Ralph Specum in Codex to generate or refresh index artifacts.

View SKILL.md on GitHub Repository
Stars 278
Forks 15

Install this agent skill to your Project

npx add-skill https://github.com/tzachbon/smart-ralph/tree/main/plugins/ralph-specum-codex/skills/ralph-specum-index

Metadata

Additional technical details for this skill

action
index
surface
helper

SKILL.md

Ralph Specum Index

Use this to generate searchable index specs for an existing codebase.

Contract

  • Index output lives under specs/.index/
  • Use stable Ralph templates for index.md, component specs, and external specs
  • Keep component and external entries deterministic and easy to diff

Action

  1. Parse the user scope such as path, types, excludes, quick mode, dry run, or force.
  2. Scan the requested code areas for controllers, services, models, helpers, migrations, or comparable project structures.
  3. Generate or update:
    • specs/.index/index.md
    • specs/.index/components/*.md
    • specs/.index/external/*.md
  4. Keep outputs deterministic so start, research, and triage can reuse them.
  5. Include external URLs, MCP endpoints, or installed skills only when the user asked for them or they are clearly relevant.
  6. In dry run mode, report what would be created without writing files.

Response Handoff

  • After updating the index, name the files that changed and summarize the index scope briefly.
  • End with exactly one explicit choice prompt:
    • approve current artifact
    • request changes
    • continue to research
  • Treat continue to research as approval of the updated index artifacts.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

tzachbon/smart-ralph

MCP Integration

This skill should be used when the user asks to "add MCP server", "integrate MCP", "configure MCP in plugin", "use .mcp.json", "set up Model Context Protocol", "connect external service", mentions "${CLAUDE_PLUGIN_ROOT} with MCP", or discusses MCP server types (SSE, stdio, HTTP, WebSocket). Provides comprehensive guidance for integrating Model Context Protocol servers into Claude Code plugins for external tool and service integration.

278 15
Explore
tzachbon/smart-ralph

Command Development

This skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.

278 15
Explore
tzachbon/smart-ralph

Plugin Settings

This skill should be used when the user asks about "plugin settings", "store plugin configuration", "user-configurable plugin", ".local.md files", "plugin state files", "read YAML frontmatter", "per-project plugin settings", or wants to make plugin behavior configurable. Documents the .claude/plugin-name.local.md pattern for storing plugin-specific configuration with YAML frontmatter and markdown content.

278 15
Explore
tzachbon/smart-ralph

Plugin Structure

This skill should be used when the user asks to "create a plugin", "scaffold a plugin", "understand plugin structure", "organize plugin components", "set up plugin.json", "use ${CLAUDE_PLUGIN_ROOT}", "add commands/agents/skills/hooks", "configure auto-discovery", or needs guidance on plugin directory layout, manifest configuration, component organization, file naming conventions, or Claude Code plugin architecture best practices.

278 15
Explore
tzachbon/smart-ralph

Hook Development

This skill should be used when the user asks to "create a hook", "add a PreToolUse/PostToolUse/Stop hook", "validate tool use", "implement prompt-based hooks", "use ${CLAUDE_PLUGIN_ROOT}", "set up event-driven automation", "block dangerous commands", or mentions hook events (PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification). Provides comprehensive guidance for creating and implementing Claude Code plugin hooks with focus on advanced prompt-based hooks API.

278 15
Explore
tzachbon/smart-ralph

Skill Development

This skill should be used when the user wants to "create a skill", "add a skill to plugin", "write a new skill", "improve skill description", "organize skill content", or needs guidance on skill structure, progressive disclosure, or skill development best practices for Claude Code plugins.

278 15
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results