mcp AGENTS.md

Instructions for working with the generated Typeship package, which resolves API definitions and keeps related SDKs, command-line tools, and agent targets current.

In plain words
What is it for?
Using the Typeship API or MCP server, authenticating with a bearer token, reading its API references, and avoiding edits that regeneration would erase.
Why use it?
They explain the package's rules, authentication, generated-code limits, and available interfaces so agents can use it safely and correctly.

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

Made for: Codex, OpenCode.

Per session 524 This file is loaded in full into every session.
When invoked 524 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.00524 $0.00524
Opus 5 $0.00262 $0.00262
Sonnet 5 $0.00105 $0.00105
Haiku 4.5 $0.00052 $0.00052

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

Security

Grade A, and why

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

How it starts

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

typeship — agent context

This package contains the generated MCP server for typeship (API v1.0.0, package v1.0.0).

Resolve an OpenAPI or GraphQL Definition, diagnose it, and keep every selected SDK, CLI, and MCP Target current.

Every operation but one requires a bearer credential: an organization API key from the console, or an OAuth access token carrying the operation's read, generate, or write capability and the organization selected during consent. OAuth grants cannot switch organizations after consent. A browser session is not a credential for this API. The exception is POST /generate, which works anonymously with the free plan's limits.

Ground rules

  • Generated code: never edit files in this package by hand — changes are lost on regeneration. Wrap the client in your own code instead.
  • Zero runtime dependencies; everything runs on platform fetch (Node 18+, browsers, edge).
  • api.md is the native method reference; api.json is the machine-readable operation, schema, safety, and example contract. Read them before guessing.

Authentication

  • Bearer token: set the TYPESHIP_TOKEN environment variable.

MCP server

  • Run typeship-mcp over stdio from an MCP client, or use npx -y --package @typeship-ax/mcp typeship-mcp. Set the package's auth environment variables in that client; --read-only prevents write tools.
  • This package exposes the compact search_docs, read_docs, and execute surface. Find an operation, read its complete contract, then call execute with its name and arguments; destructive operations return CONFIRMATION_REQUIRED until repeated with confirm: true. Operation names are not directly callable tools in this mode.
  • Tool arguments are checked against the schema before any request (unknown or mistyped arguments are one isError result with per-argument issues); pass fields (dotted paths) to keep only the result keys you need; errors carry code and next_steps.

Documentation

  • The reference for this exact package: api.md (offline, always current with the code).
  • Conceptual guides live on the docs site. For questions about how the API's concepts fit together (flows, ordering, environments), fetch https://typeship.dev/llms-full.txt and read the relevant sections; https://typeship.dev/llms.txt is the page index.

Read the full file on GitHub · 31 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 · 31 lines · 524 tokens per session scan A 581cbe5efbd0

Subscribe to this mod's changes

mcp AGENTS.md is an instructions file published in the GitHub repository typeship-ax/mcp (0 stars, last pushed 7d ago), licensed MIT. It adds 524 tokens to every session, about $0.0026 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

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

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

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

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

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

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