sentry-miniapp: Instructions file for Codex

AGENTS.md

sentry-miniapp AGENTS.md is an instructions file for Codex, OpenCode from lizhiyao/sentry-miniapp. It costs 1,346 tokens per session, scanned A, original, MIT.

A project checklist and rulebook for contributors and coding agents working on a Sentry error-monitoring SDK for mini programs. Mini programs are small apps that run inside platforms such as WeChat or Alipay.

In plain words
What is it for?
Use it before changing the SDK, especially when adding platform-specific features, changing cross-platform code, preparing a release, or reviewing the required tests and documentation.
Why use it?
It reduces the risk of breaking support across different mini-program platforms or losing fallback behaviour. It also sets expectations for tests, documentation, branches, and commit messages.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions Claude Code.

This is lizhiyao/sentry-miniapp's own configuration. It tells Codex and OpenCode how to work on sentry-miniapp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything sentry-miniapp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to lizhiyao/sentry-miniapp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/lizhiyao/sentry-miniapp/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/lizhiyao/sentry-miniapp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for sentry-miniapp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/lizhiyao/sentry-miniapp/agents-md/github.svg)](https://agentmods.dev/instructions/lizhiyao/sentry-miniapp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/lizhiyao/sentry-miniapp/agents-md"><img src="https://agentmods.dev/badge/instructions/lizhiyao/sentry-miniapp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for sentry-miniapp AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/lizhiyao/sentry-miniapp/agents-md"><img src="https://agentmods.dev/badge/instructions/lizhiyao/sentry-miniapp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,346 This file is loaded in full into every session.
When invoked 1,346 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.01346 $0.01346
Opus 5 $0.00673 $0.00673
Sonnet 5 $0.00269 $0.00269
Haiku 4.5 $0.00135 $0.00135

Measured today against content hash a16fcad74141, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

sentry-miniapp AGENTS.md 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 today.

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.md · 70 lines

How it starts

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

AGENTS.md - Agent 入场清单

sentry-miniapp 是基于 @sentry/core 的跨端小程序 Sentry SDK,覆盖微信、支付宝、字节跳动、钉钉、QQ、百度、快手,并兼容 Taro / uni-app 等跨端框架。所有功能改动都要优先保护跨端兼容性、降级路径和现有 SDK 使用方式。

本文件是 agents.md 开放标准约定的多 agent 入场清单,跨 Claude Code / Codex / Cursor / Aider / Gemini CLI 等工具通用。Claude Code 用户:本仓库的 CLAUDE.md 通过 @AGENTS.md import 同一份内容,无需重复维护。

开工先做

  • 涉及 commit、PR、分支或发版时,先看 CONTRIBUTING.md
  • 功能改造前确认对所有已支持平台的影响;如果使用某个平台特有 API,必须提供条件判断或回退机制。
  • 交付前默认跑 yarn run lintyarn run test(Vitest 单测);涉及构建产物或跨端行为时,再跑 yarn run build
  • 代码改造完成后,必须检查并更新相关文档,如 README.mddocs/README.en.mdwebsite/ 或示例工程文档。

硬规则

  • 遵守 GitHub Flow:master 是唯一长期分支;feature / fix / docs / chore 从最新 master 切短分支,通过 PR 回 master
  • 不要直接在 master 上提交;不要引入 develop 或其它长期集成分支。
  • commit 格式必须使用 Conventional Commits,并用中文 subject,例如 feat: 新增网络请求体抓取功能。推荐 scope 使用稳定模块名,如 sdk / cross-platform / integrations / transports / docs / agents-md / release
  • 遵循现有 ESLint 规范,优先使用 TypeScript。

跨端兼容性

  • 改平台能力时,同时考虑微信、支付宝、字节跳动、钉钉、QQ、百度、快手。
  • 新增平台特有 API 前,先查现有 src/crossPlatform.tssrc/types.ts 和相关 integration / transport 的抽象方式。
  • 没有同等能力的平台要有明确回退:跳过、降级、特性检测或保守默认值,避免运行期直接报错。
  • 小游戏(微信 / 抖音小游戏)没有 App()/Page()/路由,但有平台 wx.* API;用 crossPlatform.isMinigame() 区分,依赖 App/Page 的能力须守卫 no-op,小游戏专属能力(冷启动、帧率)走 MinigameIntegration / FrameRateIntegration,默认仅在小游戏环境启用。
  • 测试应覆盖平台差异入口;窄改动至少补对应单测,影响 SDK 初始化、transport、集成插件或事件构建时扩大验证范围。

sentry-miniapp 自带 skill 安装(跨 agent)

仓库根 .agents/skills/sentry-miniapp-sdk/ 是 sentry-miniapp 智能代理 skill 的单一来源,采用中性的 Agent Skills 目录:

  • Codex:原生加载 .agents/skills/sentry-miniapp-sdk/,clone 仓库即可使用。
  • Claude Code:通过软链 .claude/skills/sentry-miniapp-sdk.agents/skills/sentry-miniapp-sdk 加载,无需重复维护。

需要在其它项目全局复用时,可把同一目录拷到 agent 工具约定的 skill 根目录:

# Codex
cp -r .agents/skills/sentry-miniapp-sdk ~/.agents/skills/sentry-miniapp-sdk

# Cursor / Aider / Gemini CLI 等
# 按各工具文档,把 .agents/skills/sentry-miniapp-sdk 放到对应 skill 目录即可

Read the full file on GitHub · 70 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. today Changed · +2 tokens per session a16fcad74141
  2. 10d ago First seen · 70 lines · 1,344 tokens per session scan A bdf858ebd895

Subscribe to this mod's changes

sentry-miniapp AGENTS.md is an instructions file published in the GitHub repository lizhiyao/sentry-miniapp (682 stars, last pushed today), licensed MIT. It adds 1,346 tokens to every session, about $0.0067 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.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens