Agent skill

Adk Readme Writer

by BrainDAO in BrainDAO/adk-ts

ADK-TS README specialist. An agent skill from BrainDAO/adk-ts.

MITAuto-check: notesDevelopment

Install Adk Readme Writer

skills CLI
$ npx skills add BrainDAO/adk-ts --skill adk-readme-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install BrainDAO/adk-ts adk-readme-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/BrainDAO/adk-ts.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/adk-ts-readme-writer .claude/skills/adk-readme-writer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
adk-readme-writer
GitHub stars
119
Token cost
~2.6k tokens
SKILL.md length
461 words
Files
1
Skills in repo
3
Repo updated
First seen
Licence
MIT

At a glance

ADK-TS README specialist. An agent skill from BrainDAO/adk-ts.

  • Works in 4 steps: Read the target directory's package.json… → Identify which archetype applies (see… → Read the canonical reference README for… → …
  • Editing any README.md file in the monorepo
  • SKILL.md covers Overview, When to Use, Before Writing and Archetype 1: Root README, plus 5 more sections
  • Calls npm; reaches github.com and img.shields.io

What it does

Adk Readme Writer is an agent skill from BrainDAO/adk-ts. ADK-TS README specialist. Use when creating or editing any README.md file in the monorepo, adding new packages, apps, or starter templates. Knows the four branded README archetypes (root, package, app/contributor, starter template) and enforces consistency.

Its SKILL.md is about 2.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, Project scaffolding and Monorepo tooling. It works with npm and TypeScript. The repository describes itself as: A robust framework for building AI agents with multi-provider LLM support. The licence is MIT.

When your agent uses it

  • Editing any README.md file in the monorepo
  • Adding new packages
  • Starter templates

Example prompts

  • “/adk-readme-writer”

Requirements

  • Node.js

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Read the target directory's package.json to extract the package name, description, and version
  2. Identify which archetype applies (see below)
  3. Read the canonical reference README for that archetype
  4. Apply the adk-style-guide skill rules (brand, terminology, URLs)

What it can do on your machine

Read from SKILL.md and the folder at commit f93632d. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • github.com
    • img.shields.io
    • adk.iqai.com
    • files.catbox.moe
    • npmjs.com
    • t.me

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Adk Readme Writer loads about 2.6k tokens when it runs. Until then it costs about 69 tokens; SKILL.md has 461 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~69
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:286
    cp .env.example .env

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from BrainDAO/adk-ts at commit f93632d, republished under its MIT licence (© BrainDAO). 461 words, ~2,642 tokens.

Download SKILL.mdSave it as .claude/skills/adk-readme-writer/SKILL.md (or your agent's skills folder).
name
adk-readme-writer
description
ADK-TS README specialist. Use when creating or editing any README.md file in the monorepo, adding new packages, apps, or starter templates. Knows the four branded README archetypes (root, package, app/contributor, starter template) and enforces consistency.

ADK-TS README Writer

Overview

This skill creates and updates README files that match the exact branded patterns used across the ADK-TS monorepo. There are four distinct README archetypes — choose the correct one based on where the README lives.

When to Use

  • Creating a new README for a package, app, or starter template
  • Editing an existing README
  • Adding a new package or starter template to the monorepo
  • Reviewing READMEs for consistency

Before Writing

  1. Read the target directory's package.json to extract the package name, description, and version
  2. Identify which archetype applies (see below)
  3. Read the canonical reference README for that archetype
  4. Apply the adk-style-guide skill rules (brand, terminology, URLs)

Archetype 1: Root README

Applies to: README.md (repository root)

Reference file: README.md

Structure:

markdown
<div align="center">
  <img src="https://files.catbox.moe/vumztw.png" alt="ADK-TS Logo" width="80" />
  <br/>
  <h1>ADK-TS: The TypeScript-Native AI Agent Framework</h1>
  <b>An open-source framework for building production-ready AI agents in TypeScript. Type-safe, multi-LLM, with built-in tools, sessions, and agent orchestration.</b>
  <br/>
  <i>TypeScript-Native • Multi-Agent Systems • Production-Ready</i>

  <p align="center">
    <a href="https://www.npmjs.com/package/@iqai/adk">
      <img src="https://img.shields.io/npm/v/@iqai/adk" alt="NPM Version" />
    </a>
    <a href="https://www.npmjs.com/package/@iqai/adk">
      <img src="https://img.shields.io/npm/dm/@iqai/adk" alt="NPM Downloads" />
    </a>
    <a href="https://github.com/IQAIcom/adk-ts/blob/main/LICENSE.md">
      <img src="https://img.shields.io/npm/l/@iqai/adk" alt="License" />
    </a>
    <a href="https://github.com/IQAIcom/adk-ts">
      <img src="https://img.shields.io/github/stars/IQAIcom/adk-ts?style=social" alt="GitHub Stars" />
    </a>
  </p>
</div>

---

## 🌟 Overview

## 🚀 Key Features (emoji + link + description bullets)

## ⚡ Quick Start (CLI + manual approaches)

## 📚 Examples

## 🤝 Contributing

## 🌍 Community

## 📜 License

## 🔒 Security

---

**Ready to build your first AI agent?** Visit [https://adk.iqai.com](https://adk.iqai.com) to get started!

Key traits:

  • Most comprehensive README — acts as project landing page
  • Logo width: 80
  • Includes NPM badges
  • Community section with GitHub Discussions link
  • Security section referencing SECURITY.md

Archetype 2: Package README

Applies to: packages/adk/README.md, packages/adk-cli/README.md, packages/mcp-docs/README.md

Reference file: packages/adk/README.md

Structure:

markdown
<div align="center">
  <img src="https://files.catbox.moe/vumztw.png" alt="ADK-TS Logo" width="80" />
  <br/>
  <h1>{NPM_PACKAGE_NAME}</h1>
  <b>{PACKAGE_DESCRIPTION}</b>
  <br/>
  <i>{Keyword} • {Keyword} • {Keyword}</i>

  <p align="center">
    <a href="https://www.npmjs.com/package/{NPM_PACKAGE}">
      <img src="https://img.shields.io/npm/v/{NPM_PACKAGE}" alt="NPM Version" />
    </a>
    <a href="https://www.npmjs.com/package/{NPM_PACKAGE}">
      <img src="https://img.shields.io/npm/dm/{NPM_PACKAGE}" alt="NPM Downloads" />
    </a>
    <a href="https://github.com/IQAIcom/adk-ts/blob/main/LICENSE.md">
      <img src="https://img.shields.io/npm/l/{NPM_PACKAGE}" alt="License" />
    </a>
    <a href="https://github.com/IQAIcom/adk-ts">
      <img src="https://img.shields.io/github/stars/IQAIcom/adk-ts?style=social" alt="GitHub Stars" />
    </a>
  </p>
</div>

---

## 🌟 Overview

## 🚀 Key Features (emoji + **bold title** + description)

## 🚀 Quick Start (installation + simple example)

## ⚙️ Environment Configuration

## 📖 Basic Usage (code examples)

## 📚 Documentation (link to adk.iqai.com)

## 🤝 Contributing

## 📜 License

Key traits:

  • Logo width: 80 (consistent across all READMEs)
  • <h1> uses the npm package name (e.g., @iqai/adk)
  • Includes NPM badges with package-specific URLs
  • Code examples use TypeScript with @iqai/adk imports
  • Quick Start shows npm install command

Archetype 3: App / Contributor README

Applies to: apps/docs/README.md, apps/examples/README.md, apps/adk-web/README.md, apps/adk-api-docs/README.md

Reference files: apps/docs/README.md, apps/adk-web/README.md

Structure:

markdown
<div align="center">
  <img src="https://files.catbox.moe/vumztw.png" alt="ADK-TS Logo" width="80" />
  <br/>
  <h1>{APP_DISPLAY_NAME}</h1>
  <b>{Contributing guide for... | A collection of...}</b>
  <br/>
  <i>{Keyword} • {Keyword} • {Keyword} • {Keyword}</i>
</div>

---

## 📖 About

{For contributor guides:}
This README is specifically for contributors to {component}. ...
If you're looking to **use** {component}, visit {link}. This guide is for those who want to **contribute** to improving {it}.

{For collections like examples:}
This directory contains {description of what's inside}.

## 🌟 Features (what the app provides)

## 🚀 Getting Started

### Prerequisites

### Setting Up Development Environment

## ⚙️ Architecture Overview

## 📁 Project Structure

## 🛠️ Development Workflow

## 🧪 Testing

## 🤝 Contributing

---

**Ready to contribute?** {Encouraging CTA}

Key traits:

  • Logo width: 80
  • NO NPM badges (these are not published packages)
  • NO <p align="center"> badge block
  • Opens with contributor-oriented or collection-oriented intro
  • More detailed on internal architecture and dev workflows
  • References internal tooling (Fumadocs, TypeDoc, NestJS, etc.)
  • Keywords in <i> tag are workflow-oriented: "Setup • Development • Testing • Contributing"

Show full SKILL.md (197 more words)Show less

Archetype 4: Starter Template README

Applies to: All files in apps/starter-templates/*/README.md

Reference file: apps/starter-templates/simple-agent/README.md

Structure:

markdown
<div align="center">
  <img src="https://files.catbox.moe/vumztw.png" alt="ADK-TS Logo" width="80" />
  <br/>
  <h1>ADK-TS {Template Name} Template</h1>
  <b>Starter template for {what it does} with ADK-TS</b>
  <br/>
  <i>{Keyword} • {Keyword} • {Keyword}</i>
</div>

---

# {Template Name} Template - {Subtitle}

{One paragraph description.}

**Built with [ADK-TS](https://adk.iqai.com/) - The TypeScript-Native AI Agent Framework**

## 🎯 Features

- **{Feature name}** {description}.
- **{Feature name}** {description}.

## 🏗️ How It Works

` ` `text
{ASCII flow diagram showing the agent architecture}
` ` `

## 🚀 Quick Start

Use either approach:

- **Recommended**: scaffold a fresh project with the ADK-TS CLI.
- **Alternative**: clone the repository and copy this template folder into your own project.

### Prerequisites

- Node.js >=22.0
- pnpm
- {Template-specific requirements}

### Step 1: Create the project

` ` `bash
npx @iqai/adk-cli new --template {TEMPLATE_NAME} my-{template}
cd my-{template}
` ` `

### Step 2: Install dependencies

` ` `bash
pnpm install
` ` `

### Step 3: Configure environment variables

` ` `bash
cp .env.example .env
` ` `

Required and optional values are documented in `.env.example`.

### Step 4: Run the template

` ` `bash
pnpm dev
` ` `

## 📁 Template Structure

` ` `text
src/
├── agents/                 # Agent definitions
│   ├── agent.ts            # Root agent
│   └── {sub-agents}/       # Specialist agents
├── env.ts                  # Environment validation
└── index.ts                # Entry point
` ` `

## 🧪 Test with ADK-TS CLI

From your project directory, you can test agents without writing custom test scripts.

` ` `bash

# Option 1: Install ADK-TS CLI globally, then run

pnpm install -g @iqai/adk-cli
adk run
adk web

# Option 2: Use npx without global install

npx @iqai/adk-cli run
npx @iqai/adk-cli web
` ` `

- `adk run`: interactive terminal chat with your agent(s).
- `adk web`: launches a local server and opens the ADK-TS web interface.

## 📚 Learn More

- [ADK-TS Documentation](https://adk.iqai.com/)
- [ADK-TS CLI Documentation](https://adk.iqai.com/docs/cli)
- [GitHub Repository](https://github.com/IQAIcom/adk-ts)
- [ADK-TS Sample Projects](https://github.com/IQAIcom/adk-ts-samples)
- [GitHub Discussions](https://github.com/IQAIcom/adk-ts/discussions)
- [Telegram Community](https://t.me/+Z37x8uf6DLE3ZTQ8)

## 🤝 Contributing

This [template](https://github.com/IQAIcom/adk-ts/tree/main/apps/starter-templates/{TEMPLATE_NAME}) is open source and contributions are welcome! Feel free to:

- Report bugs or suggest improvements
- Add new agent examples
- Improve documentation
- Share your customizations

---

**🎉 Ready to build?** This template gives you everything you need to start building {type} applications with ADK-TS.

Key traits:

  • Logo width: 80
  • NO NPM badges
  • Title format: "ADK-TS {Template Name} Template"
  • Always includes "Built with ADK-TS" line after intro
  • "How It Works" ASCII diagram is required
  • Quick Start is a rigid 4-5 step format
  • "Test with ADK-TS CLI" section is identical across all templates
  • "Learn More" links are identical across all templates
  • Contributing section only differs in template folder path

Shared Boilerplate Sections (Starter Templates)

These sections MUST be identical across all starter templates (only template-specific values change):

  1. Quick Start intro paragraph (identical)
  2. Step 2: Install dependencies (identical)
  3. Step 3: Configure environment variables (identical)
  4. Test with ADK-TS CLI section (verbatim identical)
  5. Learn More links (identical base set)
  6. Contributing section (identical pattern, only folder path differs)

When updating any of these shared sections, update ALL starter templates. Use /adk-starter-sync command for this.


Consistency Rules

All READMEs must follow these rules (from adk-style-guide):

  • GitHub URL org: IQAIcom (not IQAICOM)
  • Node.js version: >=22.0
  • Docs URL: https://adk.iqai.com/
  • Logo: https://files.catbox.moe/vumztw.png
  • GitHub Discussions: https://github.com/IQAIcom/adk-ts/discussions
  • Telegram: https://t.me/+Z37x8uf6DLE3ZTQ8
  • Samples: https://github.com/IQAIcom/adk-ts-samples
  • Always "ADK-TS" never bare "ADK"
  • Never expand to "Agent Development Kit"

© BrainDAO, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/adk-ts-readme-writer of BrainDAO/adk-ts.

Open the folder on GitHubat commit f93632d

Compare with similar skills

Adk Readme Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Adk Readme Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Adk Readme Writer this skillBrainDAO/adk-ts119—~2.6kAutomated safety check: NotesMIT
Create Saleor Packagesaleor/apps162—~608Automated safety check: PassCustom licence
Add New Packageremotion-dev/remotion63k—~777Automated safety check: NotesCustom licence
Link Workspace Packagesnomcopter/react-mosaic4.8k6 repos~760Automated safety check: PassCustom licence
Add Packageremix-run/remix33k—~2kAutomated safety check: PassMIT
Building And VerifyingNangoHQ/nango13k—~902Automated safety check: PassCustom licence

Similar skills

  • Scaffold a new shared package in the saleor-apps monorepo under ./packages/.

    162 GitHub stars~608 tokensUpdated 3 days ago
    DevelopmentAuto-check passed
  • Add New Package

    remotion-dev/remotion

    Official

    Add a new package to the Remotion monorepo, including package scaffolding, monorepo registration, documentation, build scripts, and release checklist updates.

    63k GitHub stars~777 tokensUpdated yesterday
    Media & CreativeAuto-check: notes
  • Link Workspace Packages

    nomcopter/react-mosaic

    Link workspace packages in monorepos (npm, yarn, pnpm, bun).

    4.8k GitHub starsUsed in 6 repos~760 tokens
    DevelopmentAuto-check passed
  • Add Package

    remix-run/remix

    Create or align a package in the Remix monorepo to match existing package conventions.

    33k GitHub stars~2k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • A skill your agent uses when building the Nango monorepo or verifying TypeScript compilation - covers build commands, project references, common tsc errors, and package dependency order

    13k GitHub stars~902 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Update Est Fixtures

    ethereumjs/ethereumjs-monorepo

    Updates EthereumJS execution-spec test fixtures from an ethereum/execution-specs release, then (after a human merge) points the monorepo submodule, updates VM npm scripts, reports a first test run…

    2.8k GitHub stars~3.3k tokensUpdated 22 days ago
    DevelopmentAuto-check passed

More from BrainDAO/adk-ts

  • Adk Docs Writer

    BrainDAO/adk-ts

    ADK-TS documentation specialist for Fumadocs MDX pages. An agent skill from BrainDAO/adk-ts.

    119 GitHub stars~4.9k tokensUpdated 3 mo ago
    Auto-check passed
  • Adk Style Guide

    BrainDAO/adk-ts

    ADK-TS brand voice, terminology, and writing conventions. An agent skill from BrainDAO/adk-ts.

    119 GitHub stars~1.8k tokensUpdated 3 mo ago
    Auto-check passed

Works with

Categories

Questions about Adk Readme Writer

What does Adk Readme Writer do?

ADK-TS README specialist. An agent skill from BrainDAO/adk-ts. Adk Readme Writer is an agent skill from BrainDAO/adk-ts. ADK-TS README specialist.

When should I use Adk Readme Writer?

Adk Readme Writer fits situations like: editing any README.md file in the monorepo; adding new packages; starter templates.

How do I install Adk Readme Writer in Claude Code?

Run `npx skills add BrainDAO/adk-ts --skill adk-readme-writer -a claude-code`. Or copy the skill folder (.claude/skills/adk-ts-readme-writer in BrainDAO/adk-ts) into .claude/skills/adk-readme-writer in your project. Claude Code loads it when a task matches its description.

How do I install Adk Readme Writer in Codex?

Run `npx skills add BrainDAO/adk-ts --skill adk-readme-writer -a codex`. Or copy the skill folder (.claude/skills/adk-ts-readme-writer in BrainDAO/adk-ts) into .agents/skills/adk-readme-writer in your project. Codex loads it when a task matches its description.

Can I use Adk Readme Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add BrainDAO/adk-ts --skill adk-readme-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/adk-readme-writer, .gemini/skills/adk-readme-writer, .github/skills/adk-readme-writer and .opencode/skills/adk-readme-writer in your project.

What does Adk Readme Writer need to run?

Going by SKILL.md and its folder, Adk Readme Writer needs the command-line tools its instructions call (npm). Our summary lists: Node.js.

Does Adk Readme Writer access the network?

SKILL.md names 6 domains. In commands or code: github.com, img.shields.io, adk.iqai.com, files.catbox.moe, npmjs.com and t.me; the agent is likely to contact these when it follows the instructions. This is read from the text; nothing was executed.

Is Adk Readme Writer safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Adk Readme Writer use?

Adk Readme Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Adk Readme Writer use?

About 2.6k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Adk Readme Writer?

Skills that share tags, products or a category with Adk Readme Writer: Create Saleor Package (saleor/apps, 162 stars), Add New Package (remotion-dev/remotion, 63k stars), Link Workspace Packages (nomcopter/react-mosaic, 4.8k stars) and Add Package (remix-run/remix, 33k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Adk Readme Writer?

BrainDAO (a GitHub organization) maintains it in BrainDAO/adk-ts, which has 119 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on June 26, 2026.

Source: BrainDAO/adk-ts on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.