miku-indexgen-skills

miku-indexgen-skills is an Agent Skills package for using miku-indexgen from AI agent workflows.

It helps an agent create a compact file index before reading many files in full. The bundled miku-indexgen runtime scans a directory and generates index.json. When Markdown output is enabled, it also generates index.md.

In directories with many files, the generated index gives AI agents a compact overview before they choose what to read. This is intended to reduce the number and size of files an agent needs to load into context.

Use this skill when you want an agent to understand a selected documentation directory, Agent Skill package, reference directory, or other explicitly chosen file area through generated index files.

What It Does

• generates index.json for a selected directory
• optionally generates index.md
• can write outputs into the input directory or a separate output directory
• can restrict scanned extensions such as md,json
• can use UTF-8 or Shift_JIS input and output encodings
• bundles both Node.js and Java runtime artifacts for local CLI execution

index.json is generated and updated by miku-indexgen; it is not a file that needs manual maintenance.

Markdown front matter is used as agent-facing index metadata. Concise title, description, topics, category, status, audience, date, and sources fields help callers choose which files to read before loading full Markdown contents.

This repository is not an MCP server and does not replace the upstream miku-indexgen product. It packages the upstream CLI runtimes with agent-facing instructions and tests.

Quick Start

1. Confirm runtime artifacts under skills/igapyon-miku-indexgen/runtime/.
2. Run npm test.
3. Run npm run build:bundle.
4. Install the generated bundle/miku-indexgen-skills/skills/igapyon-miku-indexgen directory into your skill home.
5. In conversation, explicitly start with igapyon-miku-indexgen or miku-indexgen.

Example Agent Requests

• miku-indexgen を使って docs の index.json を作って
• igapyon-miku-indexgen で docs を走査し、workplace/indexgen に index.json と index.md を出力して
• miku-indexgen で skills 配下の md,json だけを対象に index を作って
• miku-indexgen で README と JSON 設定ファイルを探しやすい index.md も作って

The skill is intentionally opt-in. Generic requests such as "list files", "search this repository", or "read these files" should not activate it unless the user explicitly names miku-indexgen or igapyon-miku-indexgen.

Direct Runtime Examples

Generate index.json:

java -jar skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.jar --input-directory docs

Generate index.json and index.md into a separate directory:

java -jar skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.jar --input-directory docs --output-directory workplace/indexgen --markdown

Use the Node.js runtime directly:

node skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.mjs --input-directory docs --markdown

Exclude input-relative paths:

java -jar skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.jar --input-directory docs --exclude-glob "**/images/*"

Developer Commands

Run tests:

npm test

Build the installable skill bundle:

npm run build:bundle

Build the release zip:

npm run build:bundle:zip

Generate the skill-local index:

mvn generate-resources

The release zip is generated under bundle/.

Runtime Artifacts

Agent Skill package version: 1.6.2.

This repository bundles upstream GitHub Release artifacts:

• skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.mjs
• skills/igapyon-miku-indexgen/runtime/miku-indexgen-1.6.2.jar

Upstream anchors:

• igapyon/miku-indexgen release v1.6.2
• igapyon/miku-indexgen-java release v1.6.2

Runtime artifact file versions may differ between Node.js and Java artifacts. Use file-name versions for artifact selection and --version only as a smoke check that the runtime starts.

Repository Notes

• workplace/ is a local scratch area for cloned upstream repositories, generated verification files, and temporary checks. Only workplace/.gitkeep is tracked.
• Build output under bundle/ is regenerated by npm run build:bundle or npm run build:bundle:zip.

Developer Documents

• skills/igapyon-miku-indexgen/references/usage.md
• docs/development.md
• docs/miku-soft-reference.md
• skills/igapyon-miku-indexgen/references/INDEX.md

License

Apache License 2.0. See LICENSE.