openapi-mcp AGENTS.md

Repository instructions for an AI coding agent working on an OpenAPI-to-MCP server. OpenAPI is a format that describes how a web API works, while MCP lets AI tools use that API.

In plain words
What is it for?
Use them when installing dependencies, starting the server from one OpenAPI file or a directory of specifications, and running unit or integration tests.
Why use it?
They give the agent the project’s language, setup commands, file structure, and testing expectations, reducing guesswork when making changes.

Instructions file for CodexOpenCode

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 instructions/wate/openapi-mcp/agents-md
Clone the repo
git clone --depth 1 https://github.com/wate/openapi-mcp

Made for: Codex, OpenCode.

Per session 1,523 This file is loaded in full into every session.
When invoked 1,523 The same file — it is already loaded in full.
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.01523 $0.01523
Opus 5 $0.00762 $0.00762
Sonnet 5 $0.00305 $0.00305
Haiku 4.5 $0.00152 $0.00152

Measured yesterday against content hash 953f9fa3e610, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openapi-mcp 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 yesterday.

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 · 145 lines

How it starts

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

AIエージェント ガイドライン

ユーザーとのやり取りは日本語で行ってください。

プロジェクト目的

このプロジェクトは、OpenAPI仕様を入力としてMCPサーバー(stdio)を構成し、 AI連携時の実装負荷と運用負荷を下げることを目的とします。 全体方針はREADME設計メモを確認してください。

プロジェクト構造

主要なファイルとその役割を把握してください。

├ README.md                    # 人間向けの概要、使い方、導線
├ AGENTS.md                    # エージェント向けオンボーディング
├ mcp-server.mjs               # エントリーポイント(main のみ)
├ package.json                 # 依存関係と実行環境情報
├ lib/                         # ロジック分離モジュール
│   ├ args.mjs               # CLI 引数の解析
│   ├ auth.mjs               # 認証情報の解決
│   ├ config.mjs             # 設定ファイル読み込み・spec パス解決
│   ├ executor.mjs           # HTTP リクエスト実行・エラーハンドリング
│   ├ tools.mjs              # tool 名生成・公開制御・定義構築
│   ├ trimming.mjs           # レスポンストリミング
│   └ utils.mjs              # 汎用ユーティリティ
├ tests/                       # テスト
│   ├ unit/                  # ユニットテスト
│   ├ integration/           # 統合テスト
│   └ e2e/                   # E2E テスト
├ docs/                        # プロジェクト文書
│   └ design.md              # 設計方針と判断根拠
└ .github/                     # 運用ルール、補助ドキュメント

主要コマンド

基本的な実行コマンドです。

# 依存関係インストール
yarn install

# 実行権限の付与
yarn setup

# MCPServer起動(単一spec)
zx --install ./mcp-server.mjs --spec <OpenAPI仕様ファイルパス>

# MCPServer起動(ディレクトリー探索)
zx --install ./mcp-server.mjs --dir <OpenAPI仕様ディレクトリーパス>

# テスト実行(ユニット + 統合)
node --test tests/unit/*.test.mjs tests/integration/*.test.mjs

# テスト実行(E2E)
node --test tests/e2e/*.test.mjs

# テスト実行(全件)
yarn test

# Markdown検証
npx markdownlint-cli2 "README.md" "AGENTS.md"

# 日本語品質検証
npx textlint "README.md" "AGENTS.md"

継続的改善とフィードバック活用

セッション開始時は、直近のユーザー指摘と本ドキュメントを確認し、判断基準を合わせてください。

  • セッション開始時の確認事項
    • README設計メモを確認する
    • 前回の修正差分を確認し、再発しやすい指摘を先に潰す
    • 不明点は推測せず、前提条件を短く整理して確認する
  • フィードバックの記録
    • ユーザーから改善指摘を受けた場合はfeedbackスキルの利用を検討する
    • 記録実行はユーザーに確認してから行う

絶対遵守ルール

  • 前提の明示: 不明点や複数解釈がある場合は、推測で決め打ちしない
  • 段階的進行: 大きな変更は小さく分割し、都度確認しながら進める
  • 変更の局所化: 依頼範囲外の修正やリファクタリングを混在させない
  • 参照整合性: Git管理下にないファイルをリンク・参照先として記載しない
  • インストラクション準拠: 編集対象に対応する指示文書を必ず確認する

関連ドキュメント

推奨ルール

  • 単純性優先: 近い将来の変更根拠がない抽象化や設定化は持ち込まない
  • 変更の局所化: 依頼に直接関係する箇所だけを編集する
  • 早期検証: 編集直後に対象範囲の表示確認と最小限の検証コマンドを実行する

Read the full file on GitHub · 145 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. yesterday First seen · 145 lines · 1,523 tokens per session scan A 953f9fa3e610

Subscribe to this mod's changes

openapi-mcp AGENTS.md is an instructions file published in the GitHub repository wate/openapi-mcp (0 stars, last pushed 2mo ago), licensed MIT. It adds 1,523 tokens to every session, about $0.0076 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-31.

Related

Other instructions, from other repositories

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,182 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

next.js 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

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

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 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,345 tokens