Guide · Agent skill
How to use the AI Readiness Assessment agent skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
acreadiness-assess is an agent skill that scores how well a code repository is set up for AI coding tools. It runs Microsoft's AgentRC readiness scanner on the current project and turns the results into a static HTML dashboard at reports/index.html. This guide explains what an agent skill is, how to install this one, how to ask for an assessment, and what to check before running it.
Quick start
- 1Check Node.js. Confirm Node.js 20 or later is on your PATH by running node --version.
- 2Download the skill ZIP. Get the acreadiness-assess ZIP from the page where you found this guide.
- 3Install the skill. Unzip it into ~/.claude/skills/ or a project's .claude/skills/ folder, or upload the ZIP under Settings → Capabilities → Skills in the Claude apps.
- 4Make sure the reporter agent is available. Confirm the ai-readiness-reporter custom agent exists in your runtime, since it writes the dashboard.
- 5Ask for an assessment. Request an AI readiness audit of the repository, or type /acreadiness-assess, optionally adding --policy.
- 6Open the dashboard. Open reports/index.html in a browser and review the pillar scores and the prioritised remediation plan.
What an agent skill is and what this one does
An agent skill is a folder of instructions and supporting files that an AI agent loads when a request matches the skill's purpose. You do not run it like a normal program. You ask the agent for something, and it uses the skill to carry out a defined procedure.
When asked to audit a repository's AI readiness, this skill has the agent run Microsoft's AgentRC readiness scanner on the project. The scanner produces structured JSON results. A custom reporting agent, ai-readiness-reporter, then fills in a fixed HTML template and saves the dashboard at reports/index.html.
- The dashboard shows an overall score, maturity level and grade.
- It breaks down nine pillars: eight under Repo Health and one under AI Setup.
- Each pillar gets an AI relevance tag (High, Medium or Low) and a specific recommendation.
- It lists a prioritised remediation plan and the active scoring policy.
- The skill measures only. It does not change the project's code, and it only creates reports/index.html.
Install the acreadiness-assess skill
Download the skill's ZIP file from the page where you found this guide. Then choose one of the two installation routes below.
For Claude Code, unzip the file into ~/.claude/skills/ to make it available in all your projects, or into a project's .claude/skills/ folder to limit it to that project.
In the Claude apps, you can upload the ZIP instead. Open Settings, go to Capabilities, then Skills, and upload it there.
- Personal install: unzip into ~/.claude/skills/
- Project install: unzip into the project's .claude/skills/ folder
- Claude apps: Settings → Capabilities → Skills, then upload the ZIP
Check the requirements before you run it
The scan needs Node.js 20 or later on your PATH. If you are not sure what you have installed, run node --version in a terminal. The scan also fetches the AgentRC package from GitHub, so the machine needs network access to GitHub.
The reporting step needs a custom agent named ai-readiness-reporter to be available in your runtime. An optional policy file or package can be used for organisation-specific scoring, but it is not required.
- Node.js 20 or later on PATH
- npx access to fetch github:microsoft/agentrc from GitHub
- Network access to GitHub
- The ai-readiness-reporter custom agent available in the runtime
- Optional: a policy file or package for org-specific scoring
node --versionRun an assessment with a natural request
You do not need to remember a command. Ask in plain language, for example that you want the AI readiness of the repo assessed, audited or scored. The skill is written to trigger on requests to assess, audit or score a repository's AI readiness.
You can also invoke it directly as a slash command. The skill accepts two optional arguments: --policy, which takes a path or package, and --per-area. The agent runs the scan from the repository root with JSON output.
When the scan finishes, the agent tells you where the report is and summarises the maturity level, overall score, the three lowest-scoring pillars and the single highest-leverage next action. That next action is usually to run the acreadiness-generate-instructions skill.
- Plain request: 'Audit the AI readiness of this repo.'
- Slash command: /acreadiness-assess
- With a policy: /acreadiness-assess --policy ./policies/strict.json
- Open the result: reports/index.html, which works under file://
npx -y github:microsoft/agentrc readiness --json [--policy <source>] [--per-area]Use a policy for consistent scoring across repositories
A policy changes how the assessment is scored. Organisations can use one shared policy across several repositories so that results are comparable. If you do not supply one, the agent checks agentrc.config.json for a policies array. If neither is present, the scan uses built-in defaults.
The dashboard shows the active policy, including any disabled or overridden criteria and thresholds. For background on policies, the agent can suggest the acreadiness-policy skill.
- Passed with --policy: that source is used.
- Otherwise: a policies array in agentrc.config.json is used.
- Otherwise: built-in defaults apply.
Use the assessment in CI
The skill's notes recommend the AgentRC command with a fail level for CI gating. The level is a number from 1 to 5. Use this if you want a build to fail when readiness falls below the level you choose.
The skill itself is an interactive assessment. The CI command below is the AgentRC CLI, as named in the skill notes.
agentrc readiness --fail-level <n>What people use it for
- Checking which parts of a repository would help AI coding tools work well, as a structured checklist.
- Preparing a maintainer's repository for AI-assisted development before inviting contributors who use AI tools.
- Applying one shared scoring policy to several repositories so their results can be compared.
- Producing a committed HTML report that the team can open with file:// and review in a pull request.
Frequently asked questions
Is the acreadiness-assess skill free to use?
The skill is published under the MIT licence. The AgentRC package it fetches from GitHub is a separate project, and this page does not state its licence, so check that repository before relying on it.
What do I need to install acreadiness-assess?
You need Node.js 20 or later on your PATH, network access to GitHub so npx can fetch the AgentRC package, and the ai-readiness-reporter custom agent in your runtime. A policy file is optional.
How do I install an agent skill in Claude?
Download the skill's ZIP and unzip it into ~/.claude/skills/ for all projects, or into a project's .claude/skills/ folder. In the Claude apps, open Settings, go to Capabilities, then Skills, and upload the ZIP.
Does this skill change my code?
No. The skill is a measurement step. Its only file output is reports/index.html, and it does not modify other repository files.
Is it safe to run?
The skill runs scripts and uses the network. It executes a remote npm package fetched from GitHub, so do not use it where running external npm packages is not permitted. It only scores AI readiness and is not an independent security audit.
How is this different from AgentRC's built-in HTML report?
AgentRC has its own renderer through the --visual or --output report.html options, but its output is generic. This skill uses a custom agent and a fixed template to produce a more tailored dashboard with a prioritised fix list.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use this skill if you want a structured, repeatable checklist of what would help AI coding tools work well in a repository, or if your organisation wants one scoring policy across several projects. Skip it if you cannot install Node.js 20 or run external npm packages, or if you need an independent security or code-quality audit, since it only scores AI readiness.
Download the skill