agentmods.dev

documentation

Guidance for documenting software changes, pull requests, and releases. It covers required pull-request sections, changelog entries, and the technical details feature documentation should include.

In plain words
What is it for?
Use it when writing a pull-request description, release notes, a changelog entry, or documentation for a new feature or change.
Why use it?
It prevents documentation from missing repository-required sections or leaving out important information about user impact, testing, and breaking changes.

Skill for Claude CodeCodex

22k 2d ago A scan 22 tokens original Apache-2.0
View the source file comet-ml/opik
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/comet-ml/opik/documentation
Any agent
npx skills add comet-ml/opik --skill documentation
Clone the repo
git clone --depth 1 https://github.com/comet-ml/opik

Made for: Claude Code, Codex.

Per session 22 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 952 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00022 $0.00952
Opus 5 $0.00011 $0.00476
Sonnet 5 $0.00004 $0.00190
Haiku 4.5 $0.00002 $0.00095

Measured 2d ago against content hash 7cf01d6d1244, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/documentation/SKILL.md · 94 lines

How it starts

The opening of the file, as written. The whole thing — 94 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation

PR Description

Use the repository template at .github/pull_request_template.md — read the FULL file before drafting (the required sections continue past the first screen). CI (.github/workflows/pr-lint.yml) fails any PR whose description is missing one of these exact headings:

  • ## Details
  • ## Change checklist
  • ## Issues
  • ## Testing
  • ## Documentation

Also fill in the template's ## AI-WATERMARK section (yes/no; if yes: Tools, Model(s), Scope, Human verification). Never invent a different structure such as ## Summary / ## Test Plan.

Changelog Entry

### [VERSION] - [DATE]

#### New Features
- **Feature Name**: Brief description

#### Improvements
- **Improvement**: What changed and why

#### Bug Fixes
- **Fix**: What was broken (#issue)

#### Breaking Changes
- **Change**: What breaks, migration steps

Feature Documentation

When documenting a feature, cover:

User Impact

  • What capability does this add?
  • How do users access it?

Technical Changes

  • API changes (endpoints, params)
  • SDK changes (new methods)
  • Database migrations
  • Config changes

Breaking Changes (if any)

  • What breaks
  • Migration steps

Key Files

  • apps/opik-documentation/documentation/fern/docs-v2/self-host/changelog.mdx - Self-hosted deployment changelog (breaking/critical changes only; the former repo-root CHANGELOG.md was removed)
  • apps/opik-documentation/documentation/fern/docs-v2/changelog/ - Main product docs changelog entries (dated .mdx files)
  • apps/opik-documentation/documentation/fern/docs-v2/development/optimization-runs/changelog.mdx - Agent Optimizer release changelog
  • apps/opik-documentation/documentation/fern/docs.yml - Docs routing/navigation source of truth for changelog surfaces
  • .github/release-drafter.yml - Release template

Changelog Routing Rules

  • Pick the changelog target by scope; do not default everything to one surface.
  • Use apps/opik-documentation/documentation/fern/docs-v2/self-host/changelog.mdx only for self-hosted deployment breaking/critical/security-impacting notes.
  • Use apps/opik-documentation/documentation/fern/docs-v2/changelog/*.mdx for general Opik product release notes shown in /docs/opik/changelog.
  • Use apps/opik-documentation/documentation/fern/docs-v2/development/optimization-runs/changelog.mdx for Agent Optimizer version updates (for example sdks/opik_optimizer releases like 3.1.0).
  • Liquibase changelog.xml files are migration manifests, not user-facing release-note changelogs.
  • If unsure where an entry belongs, confirm the surface from apps/opik-documentation/documentation/fern/docs.yml before editing.

Read the full file on GitHub · 94 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 94 lines · 22 tokens per session scan A 7cf01d6d1244

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository comet-ml/opik (21,685 stars, last pushed 2d ago), licensed Apache-2.0. It adds 22 tokens to every session and 952 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Data and AIGit and workflowLangChainWriting and docsllama-indexopen-sourceopenaiplaygroundprompt-engineering
Related

Other skills, from other repositories

swarms

Build agents and multi-agent systems with the Swarms framework — the Agent class, tools, autonomous loops, memory, and the 15+ multi-agent architectures (SequentialWorkflow, ConcurrentWorkflow, GraphWorkflow, HierarchicalSwarm, SwarmRouter, and more). Use whenever writing, reviewing, or debugging code that imports…

kyegomez/swarms · 73 tokens

greeting-user

Explains how to properly greet the user.

langchain4j/langchain4j · 12 tokens

code-review

Perform comprehensive code reviews focusing on best practices, security vulnerabilities, performance optimization, and maintainability.

kyegomez/swarms · 21 tokens

gh-issues

Fetch GitHub issues, spawn sub-agents to implement fixes and open PRs, then monitor and address PR review comments. Usage: /gh-issues [owner/repo] [--label bug] [--limit 5] [--milestone v1.0] [--assignee @me] [--fork user/repo] [--watch] [--interval 5] [--reviews-only] [--cron] [--dry-run] [--model glm-5]…

the-open-agent/openagent · 116 tokens

canvas

Display HTML content on connected OpenClaw nodes (Mac app, iOS, Android).

the-open-agent/openagent · 0 tokens

peekaboo

Capture and automate macOS UI with the Peekaboo CLI.

the-open-agent/openagent · 17 tokens