notion-cli: Instructions file for Claude Code

AGENTS.md

notion-cli AGENTS.md is an instructions file for Claude Code, Codex, OpenCode from nyosegawa/notion-cli. It costs 895 tokens per session, scanned A, original, MIT.

A project instruction file for an AI coding agent working on a command-line tool that connects to Notion, a workspace and note-taking service. It documents the tool’s commands, code structure, development phases, and rules.

In plain words
What is it for?
Use it to guide work on Notion command-line features, API connections, tests, and documentation. It also describes the project’s build, type-checking, linting, and test workflow.
Why use it?
It gives the agent the project context and working rules needed to make changes consistently. It also points to the correct API details and required checks.

Instructions file for Claude CodeCodexOpenCode

Written for Claude Code and Codex and OpenCode: PostToolUse hook event, but also the file is AGENTS.md. Also seen: reads .claude/ paths.

This is nyosegawa/notion-cli's own configuration. It tells Claude Code, Codex and OpenCode how to work on notion-cli 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 notion-cli configures →

Reuse

Borrowing it

Nothing to install: this file belongs to nyosegawa/notion-cli. 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/nyosegawa/notion-cli/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/nyosegawa/notion-cli

Made for: Claude Code, 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 notion-cli AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/nyosegawa/notion-cli/agents-md/github.svg)](https://agentmods.dev/instructions/nyosegawa/notion-cli/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/nyosegawa/notion-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/nyosegawa/notion-cli/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 notion-cli AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/nyosegawa/notion-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/nyosegawa/notion-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 895 This file is loaded in full into every session.
When invoked 895 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.00895 $0.00895
Opus 5.5 $0.00358 $0.00358
Sonnet 5.5 $0.00179 $0.00179
Haiku 4.5 $0.00089 $0.00089

Measured 2mo ago against content hash deb1138da8a3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

notion-cli 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 2mo 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.md · 60 lines

How it starts

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

ncli

Notion MCP + REST API 対応の CLI。MCP は OAuth、REST API は Integration Token で認証。

Commands

npm run build && npm run typecheck && npm run lint && npm test

Structure

  • docs/ — 設計 (architecture, commands, auth, design-decisions, agent-first-design)
  • docs/agent-first-design.md — Agent-first CLI 設計思想 (出力・ディスカバリ・エラーの設計原則)
  • research/ — 調査結果 (事実のみ)
  • skills/ — Agent Skills (skills/notion/ — ncli 活用スキル)
  • src/rest/ — REST API クライアント (client, with-rest-client)
  • PHASE.md — フェーズ計画 (チェックボックスで進捗追跡)

Phase Workflow

PHASE-N 指定時:

  1. PHASE.md 読み → 未完了項目確認 (前フェーズの備考も必読)
  2. docs/commands.md で CLI 仕様確認
  3. research/01-notion-remote-mcp-tools.md で MCP ツールの実際の inputSchema を確認 (引数名はここが正)
  4. 既存コマンド (src/commands/search.ts 等) のパターンを踏襲:
    • buildXxxCall() 純粋関数で CLI→MCP 引数マッピング
    • withConnection() ヘルパーで接続ボイラープレート
    • printOutput() + cmd.optsWithGlobals() で --json/--raw 対応
    • --data フラグで JSON 直接指定 (他フラグを上書き)
  5. テスト先行 → 実装 → npm run build && npm run typecheck && npm run lint && npm test 通過
  6. 完了項目を [x] に更新、全完了でフェーズ見出しに ✅
  7. 変更を commit & push (コミットメッセージは変更内容を要約)

Rules

  • biome.json を編集しない
  • --no-verify を使わない
  • テストを書いてから実装 (テストが仕様)
  • ncli api escape hatch を常に維持
  • エラーは CliError (What + Why + Hint パターン)。プロダクションコードで new Error() は使わない
  • 出力は --json / --raw 対応必須。デフォルトは JSON テキストを pretty-print
  • MCP の isError レスポンスは CliError に変換 (agent-recoverable なヒント付き)
  • --data の JSON パースエラーは parseJsonData() ヘルパー経由で CliError に統一
  • MCP ツール引数名は公式ドキュメントではなく research/01-notion-remote-mcp-tools.md の inputSchema が正
  • MCP ツール名を CLI のインターフェースとして露出しない(ncli api の escape hatch のみ)
  • REST API エラーも CliError に変換 (restErrorToCliError())。REST コマンドの出力は printRestOutput() を使用
  • 設計原則の詳細は docs/agent-first-design.md を参照

Testing

  • vitest (src/**/*.test.ts)、引数パース・マッピング優先
  • MCP 接続はモック (E2E は PHASE-5)

Harness

  • PostToolUse: biome check --fix 自動実行
  • PreToolUse: biome.json / .claude/settings.json 編集ブロック
  • Lefthook: pre-commit で lint + test

Read the full file on GitHub · 60 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. 2mo ago First seen · 60 lines · 895 tokens per session scan A deb1138da8a3

Subscribe to this mod's changes

notion-cli AGENTS.md is an instructions file published in the GitHub repository nyosegawa/notion-cli (57 stars, last pushed 7mo ago), licensed MIT. It adds 895 tokens to every session, about $0.0036 per session on Opus 5.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

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 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 · 4,261 tokens