micro-rq logomicro-rq

Documentation

AI Agents

Point coding agents at version-matched micro-rq docs bundled in node_modules.

AI coding agents

micro-rq ships version-matched agent docs inside the npm package.

When an app installs micro-rq, those docs are available at node_modules/micro-rq/dist/docs/ after installation.

Install the local skill so coding agents use copied references for the installed package version instead of stale training data or guessed APIs.

Key points

  • Creates a project-local .agents/micro-rq skill.
  • Keeps API guidance tied to the installed micro-rq version.
  • Avoids generated hooks, wrapper APIs, or options that are not part of micro-rq.

Bundled docs path

The package build copies agent-focused docs into dist/docs.

After installing the package, agents should read from the installed dependency path in the consuming project.

TypeScript
1node_modules/micro-rq/dist/docs/2  index.md3  create-micro-api.md4  create-token-provider.md5  resources.md6  tanstack-query.md7  errors.md

Local skill install

Run the CLI command from your project root to add the local micro-rq skill automatically.

The command creates .agents/micro-rq when it does not exist and updates the generated skill files when bundled docs change.

TypeScript
1npx micro-rq agents init

Generated skill structure

SKILL.md contains the skill frontmatter and links to the copied reference docs.

The markdown docs are stored under references so agents can load only the relevant file for the task.

TypeScript
1.agents/2  micro-rq/3    SKILL.md4    references/5      index.md6      create-micro-api.md7      create-token-provider.md8      resources.md9      tanstack-query.md10      errors.md

How agents should use it

Before editing any micro-rq API client, resource, auth, query, mutation, invalidation, or error-handling code, read the relevant local doc file.

Use index.md first when the task is broad. Use the focused files when the task names a specific feature.

`create-micro-api.md`
API clients, shared config, extend, headers, and error observation.
`resources.md`
Resource definitions, endpoint variables, request mappers, and query keys.
`tanstack-query.md`
useQuery, useMutation, prefetching, invalidation, and direct calls.
`create-token-provider.md`
Access tokens, refresh tokens, retry behavior, and auth modes.
`errors.md`
MicroApiError, MicroAuthRequiredError, and error handling.