This commit is contained in:
2026-08-15 15:42:41 -04:00
commit 379add3932
26 changed files with 3286 additions and 0 deletions

View File

@@ -0,0 +1,66 @@
# Tool: Tool Catalog Maintainer
## Purpose
Create and maintain a `README.md` catalog for a user-specified directory containing subfolders of tools, prompts, scripts, docs, workflows, skills, or other reusable resources.
The README is a living catalog. It should improve over time as new subfolders are added and existing ones are updated. Future humans and LLM agents will refer to this README to decide which resource to use for a request.
Invoke this tool when the user asks to:
- create a catalog README for a folder of tools/resources
- update an existing catalog after tools change
- summarize available prompts, scripts, docs, workflows, or reusable assets
- make a directory easier for LLMs to navigate
- document a collection of reusable tools
- generate or refresh an index for agent skills, prompts, scripts, references, or workflows
## Inputs
| Layer | Path | Required | Notes |
| --- | --- | --- | --- |
| Layer 4 working | `<target-folder>/` | Yes | The folder the user points to. It should contain one or more direct subfolders to catalog. |
| Layer 4 working | `<target-folder>/README.md` | No | Existing catalog to preserve and improve when present. |
| Layer 3 reference | `tools/tool-catalog-maintainer/references/catalog-format.md` | Yes | Defines the recommended README structure and cataloging rules. |
## Process
1. Confirm the target folder exists.
2. Inspect the target folder's direct subfolders. Treat each direct subfolder as one catalog entry unless the user's request says otherwise.
3. For each subfolder, inspect enough contents to understand its purpose and use:
- `README.md`, `CONTEXT.md`, `SKILL.md`, `PROCEDURE.md`, and other Markdown files
- prompt files
- scripts such as `.py`, `.sh`, `.js`, `.ts`, `.rb`, `.go`, etc.
- config files such as `package.json`, `pyproject.toml`, `requirements.txt`, `uv.lock`, `.env.example`
- `references/`, `docs/`, `assets/`, `output/`, or similarly named support folders
4. Do not deeply read generated outputs, large dependency folders, archives, or binary assets unless they are necessary to identify the tool.
5. If a catalog README already exists, preserve useful existing content and improve it rather than replacing blindly.
6. Write for future LLM consumption:
- use explicit folder names and paths
- state when to use each tool
- name key files and entry points
- call out setup requirements and cautions
- prefer structured tables plus short per-tool sections
7. Create or update `<target-folder>/README.md` using the format in `references/catalog-format.md`.
8. Verify the README covers every relevant direct subfolder and does not invent capabilities not supported by the inspected files.
## Outputs
Update or create:
```text
<target-folder>/README.md
```
The README should be a durable catalog, not a one-time summary.
## Verify
Before finishing, verify that:
- the target folder exists
- every relevant direct subfolder is represented in the catalog
- each entry has a purpose and “when to use” guidance
- key files or entry points are listed where known
- setup or dependency notes are included when visible
- existing README content was preserved when useful
- unsupported claims were avoided

View File

@@ -0,0 +1,21 @@
# Tool Catalog Maintainer
This folder contains the `tool-catalog-maintainer` ICM tool/agent skill.
## Start here
- Agent operating contract: [`CONTEXT.md`](CONTEXT.md)
- Agent Skills adapter: [`SKILL.md`](SKILL.md)
- Catalog README format rules: [`references/catalog-format.md`](references/catalog-format.md)
## Intent
Use this tool to create or update a living `README.md` catalog for a target folder of tools, prompts, scripts, docs, workflows, skills, or reusable resources.
Example request:
```text
Use tool-catalog-maintainer on tools/
```
`CONTEXT.md` is the source of truth for how the tool runs. Keep this README as a short landing page only.

View File

@@ -0,0 +1,52 @@
---
name: tool-catalog-maintainer
description: Creates and maintains a README.md catalog for a directory containing subfolders of tools, prompts, scripts, docs, workflows, skills, or reusable resources. Use when asked to catalog, index, summarize, or update documentation for a folder of tools so humans or LLMs can quickly choose the right resource.
---
# Tool Catalog Maintainer
## Purpose
Create and maintain a `README.md` catalog for a user-specified directory containing subfolders of tools, prompts, scripts, docs, workflows, skills, or other reusable resources.
The README is a living catalog. It should improve over time as new subfolders are added and existing ones are updated. Future humans and LLM agents will refer to this README to decide which resource to use for a request.
## When to use
Use this skill when the user asks to:
- create a catalog README for a folder of tools/resources
- update an existing catalog after tools change
- summarize available prompts, scripts, docs, workflows, or reusable assets
- make a directory easier for LLMs to navigate
- document a collection of reusable tools
- generate or refresh an index for agent skills, prompts, scripts, references, or workflows
## Workflow
1. Confirm the target folder exists.
2. Inspect the target folder's direct subfolders. Treat each direct subfolder as one catalog entry unless the user says otherwise.
3. For each subfolder, inspect enough contents to understand its purpose and use:
- `README.md`, `CONTEXT.md`, `SKILL.md`, `PROCEDURE.md`, and other Markdown files
- prompt files
- scripts such as `.py`, `.sh`, `.js`, `.ts`, `.rb`, `.go`, etc.
- config files such as `package.json`, `pyproject.toml`, `requirements.txt`, `uv.lock`, `.env.example`
- `references/`, `docs/`, `assets/`, `output/`, or similarly named support folders
4. Do not deeply read generated outputs, dependency folders, archives, or binary assets unless needed to identify the tool.
5. If a catalog README already exists, preserve useful existing content and improve it rather than replacing blindly.
6. Write for future LLM consumption:
- use explicit folder names and paths
- state when to use each tool
- name key files and entry points
- call out setup requirements and cautions
- prefer structured tables plus short per-tool sections
7. Create or update `<target-folder>/README.md` using `references/catalog-format.md`.
8. Verify the README covers every relevant direct subfolder and does not invent unsupported capabilities.
## Output
Create or update:
```text
<target-folder>/README.md
```

View File

@@ -0,0 +1,60 @@
# Catalog README Format
Use this reference when creating or updating a catalog README for a folder of tools, prompts, scripts, docs, workflows, or other reusable resources.
## Recommended README shape
```markdown
# Tool Catalog
This README catalogs the tools and resources in this directory. It is intended for humans and LLM agents to quickly identify what is available and when to use it.
## Catalog
| Tool / Folder | Purpose | Key Files | When to Use |
| --- | --- | --- | --- |
| `example-tool/` | Brief summary of what it does. | `README.md`, `script.py` | Use when... |
## Tools
### `example-tool/`
**Purpose:**
Describe what this tool/resource does in 1–3 sentences.
**Contents:**
- `README.md` — usage notes and overview
- `script.py` — command-line entry point
- `references/` — supporting documentation
**Use when:**
Describe the requests or situations where an agent should choose this tool.
**Setup / dependencies:**
List visible install steps, runtimes, package managers, API keys, or “None noted.”
**Notes:**
Include cautions, output locations, maintenance hints, or limitations.
## Maintenance Notes
When adding or updating a tool folder, update this README with:
- purpose
- key files and entry points
- usage guidance
- setup requirements
- notable changes or cautions
```
## Cataloging rules
- Prefer accuracy over completeness. If purpose is unclear, say so and name the files inspected.
- Do not claim a tool can do something unless the files support it.
- Keep the table compact; put detail in the per-tool sections.
- Include exact relative paths so future agents can load the right files quickly.
- Distinguish source files from generated `output/` artifacts.
- Mention whether a tool is prompt-only, script-driven, documentation-only, or a workflow.
- If a folder has its own README, use it as the primary source but still verify key files.
- Preserve useful existing catalog notes during updates.
- Remove stale entries only when the corresponding folder is gone or clearly obsolete.