Adk Sample Creator
google/adk-python
Creates a new sample agent in the ADK Python repository — the sample directory, its agent.py, and its README.md — following the conventions the existing samples already use.
Conventions for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads, math markup).
Install API Docstring
$ npx skills add GPlates/GPlates --skill api-docstring -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install GPlates/GPlates api-docstring --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/api-docstring .claude/skills/api-docstring && rm -rf skills-srcUse ~/.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/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .claude/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstringType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add GPlates/GPlates --skill api-docstring -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install GPlates/GPlates api-docstring --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/api-docstring .agents/skills/api-docstring && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .agents/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add GPlates/GPlates --skill api-docstring -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install GPlates/GPlates api-docstring --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/api-docstring .cursor/skills/api-docstring && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .cursor/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/GPlates/GPlates.git --path .claude/skills/api-docstring--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add GPlates/GPlates --skill api-docstring -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install GPlates/GPlates api-docstring --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/api-docstring .gemini/skills/api-docstring && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .gemini/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install GPlates/GPlates api-docstringInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add GPlates/GPlates --skill api-docstring -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/api-docstring .github/skills/api-docstring && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .github/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add GPlates/GPlates --skill api-docstring -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install GPlates/GPlates api-docstring --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/GPlates/GPlates.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/api-docstring .opencode/skills/api-docstring && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "api-docstring" agent skill from https://github.com/GPlates/GPlates/tree/main/.claude/skills/api-docstring into .opencode/skills/api-docstring/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docstring", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
api-docstring- GitHub stars
- 154
- Token cost
- ~1k tokens
- SKILL.md length
- 472 words
- Files
- 1
- Skills in repo
- 6
- Repo updated
- First seen
- Licence
- Custom licence
At a glance
Conventions for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads, math markup).
- Works in 8 steps: 100% markup-free. No :class:/:meth:… → Hybrid syntax: prose where unambiguous… → Top-level union separator is , or. | is… → …
- Editing a docstring in src/api/.cc
- SKILL.md covers Where docstrings live, Two consumers, one style, Signature and body and Overloads, plus 3 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
API Docstring is an agent skill from GPlates/GPlates. Conventions for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads, math markup). Use whenever adding or editing a docstring in src/api/.cc or src/qt-resources/python/api/.py, or reviewing one.
Its SKILL.md is about 1k 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. It works with Python. The repository describes itself as: GPlates is a program for visualising and manipulating plate tectonic reconstructions. PyGPlates is a Python package containing the core plate reconstruction functionality in…
When your agent uses it
- Editing a docstring in src/api/.cc
- Src/qt-resources/python/api/.py
Example prompts
- “Use the api-docstring skill to convention for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads…”
- “/api-docstring”
Requirements
- Python 3
Workflow steps
8 steps, taken from the first numbered list in SKILL.md.
- 100% markup-free. No :class:/:meth: roles, no literals , no *emphasis*.
- Hybrid syntax: prose where unambiguous (list of GeometryOnSphere), Python brackets when
- Top-level union separator is , or. | is only used inside brackets
- Never / as a union separator — Sphinx does not split on it, so neither half links. Write
- No conditionals. "(if *return_x* is True)" belongs in :returns:, where roles and
- Real Python type names, singular — str not string/strings, int not integer,
- Field order and spelling: :returns: (prose, optional) directly before :rtype:. Spell
- Enum-value lists keep the values un-italicised; "returns the default argument" is written
What it can do on your machine
Read from SKILL.md and the folder at commit e845347. 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
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
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
API Docstring loads about 1k tokens when it runs. Until then it costs about 64 tokens; SKILL.md has 472 words of instructions outside code blocks.
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 passed
The automated check found no risky patterns in SKILL.md.
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
Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 472 words (~1,042 tokens).
“Read @docs/pygplates/README.md — it is the authoritative reference and this skill is a summary of its "Docstring conventions" and "Math markup" sections. Read process_docstring in docs/pygplates/conf.py.in before changing docstring layout (as opposed to wording).”
- name
- api-docstring
Files
Just SKILL.md in .claude/skills/api-docstring of GPlates/GPlates.
Open the folder on GitHubat commit e845347
Compare with similar skills
API Docstring 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Docstring this skillGPlates/GPlates | 154 | — | ~1k | Automated safety check: Pass | Custom licence | |
| Adk Sample Creatorgoogle/adk-python | 22k | — | ~1.3k | Automated safety check: Pass | Apache-2.0 | |
| Crafting Effective Readmescumbucadev/cinemaempoa | 146 | 5 repos | ~669 | Automated safety check: Pass | GPL-3.0 | |
| Acquire Codebase Knowledgegithub/awesome-copilot | 40k | 1 repos | ~2.3k | Automated safety check: Pass | MIT | |
| Docs Conventionsflet-dev/flet | 17k | — | ~1.6k | Automated safety check: Pass | Apache-2.0 | |
| DDNS Provider DevelopmentNewFuture/DDNS | 4.7k | — | ~558 | Automated safety check: Pass | MIT |
Similar skills
- Official
Crafting Effective Readmes
cumbucadev/cinemaempoa
A skill your agent uses when writing or improving README files.
- Official
Acquire Codebase Knowledge
github/awesome-copilot
Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.
Docs Conventions
flet-dev/flet
A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…
DDNS Provider Development
NewFuture/DDNS
Adds or changes a DNS provider in the DDNS project while keeping its code, schemas, tests and Chinese and English docs consistent.
Mkdocs
jeka-dev/jeka
MkDocs documentation project reference covering CLI commands, mkdocs.yml configuration, Material theme setup, and plugin integration.
More from GPlates/GPlates
Build Gplates
GPlates/GPlates
Configure, build and test the GPlates desktop application. An agent skill from GPlates/GPlates.
Build Pygplates
GPlates/GPlates
Configure, build and test pyGPlates. An agent skill from GPlates/GPlates.
Cpp Test
GPlates/GPlates
Conventions for adding or modifying C++ unit tests in GPlates (GoogleTest, src/unit-test/).
Docs Build
GPlates/GPlates
Build the pyGPlates Python API documentation (Sphinx, docs-pygplates).
Release Wheel
GPlates/GPlates
Walk through publishing a pyGPlates release to PyPI - version bump, release tag, and the approval gate.
Related
Works with
Categories
Questions about API Docstring
What does API Docstring do?
Conventions for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads, math markup). API Docstring is an agent skill from GPlates/GPlates. Conventions for writing or reviewing pyGPlates Python API docstrings (signature-first line, type fields, overloads, math markup).
When should I use API Docstring?
API Docstring fits situations like: editing a docstring in src/api/.cc; src/qt-resources/python/api/.py.
How do I install API Docstring in Claude Code?
Run `npx skills add GPlates/GPlates --skill api-docstring -a claude-code`. Or copy the skill folder (.claude/skills/api-docstring in GPlates/GPlates) into .claude/skills/api-docstring in your project. Claude Code loads it when a task matches its description.
How do I install API Docstring in Codex?
Run `npx skills add GPlates/GPlates --skill api-docstring -a codex`. Or copy the skill folder (.claude/skills/api-docstring in GPlates/GPlates) into .agents/skills/api-docstring in your project. Codex loads it when a task matches its description.
Can I use API Docstring 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 GPlates/GPlates --skill api-docstring -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-docstring, .gemini/skills/api-docstring, .github/skills/api-docstring and .opencode/skills/api-docstring in your project.
What does API Docstring need to run?
SKILL.md names no scripts, command-line tools or credentials: API Docstring is instructions for the agent only. Our summary lists: Python 3.
Does API Docstring access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is API Docstring safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does API Docstring use?
API Docstring has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.
How many tokens does API Docstring use?
About 1k tokens (SKILL.md is roughly 4.2k 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 API Docstring?
Skills that share tags, products or a category with API Docstring: Adk Sample Creator (google/adk-python, 22k stars), Crafting Effective Readmes (cumbucadev/cinemaempoa, 146 stars), Acquire Codebase Knowledge (github/awesome-copilot, 40k stars) and Docs Conventions (flet-dev/flet, 17k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Docstring?
GPlates (a GitHub organization) maintains it in GPlates/GPlates, which has 154 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 6, 2026.
Source: GPlates/GPlates on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.