clarity-api-mcp: Instructions file for Codex

AGENTS.md

clarity-api-mcp AGENTS.md is an instructions file for Codex, OpenCode from thomastraum/clarity-api-mcp. It costs 682 tokens per session, scanned A, original, MIT.

Repository instructions for clarity-api-mcp, an MCP server that exposes Clarity image-upscaling models and can optionally download results.

In plain words
What is it for?
Use them when installing, building, testing, running, or changing the Bun TypeScript server and its model, request, publishing, and environment-handling code.
Why use it?
They give contributors a single reference for the project structure, supported operations, setup commands, tests, and API-source rules.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is thomastraum/clarity-api-mcp's own configuration. It tells Codex and OpenCode how to work on clarity-api-mcp 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 clarity-api-mcp configures →

Reuse

Borrowing it

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

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 clarity-api-mcp AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/thomastraum/clarity-api-mcp/agents-md.svg)](https://agentmods.dev/instructions/thomastraum/clarity-api-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/thomastraum/clarity-api-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/thomastraum/clarity-api-mcp/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 682 This file is loaded in full into every session.
When invoked 682 The same file — it is already loaded in full.
Security scan A 1 finding. 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.00682 $0.00682
Opus 5 $0.00341 $0.00341
Sonnet 5 $0.00136 $0.00136
Haiku 4.5 $0.00068 $0.00068

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

Security

Grade A, and why

clarity-api-mcp AGENTS.md scanned grade A with 1 finding 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 7d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- `src/clarity.ts` is the Bun Shell `curl` client, result-URL parser, and optional download.
AGENTS.md · 50 lines

How it starts

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

Repository Guidelines

Project Structure

  • src/index.ts is the MCP stdio server (clarity_list_models, clarity_upscale).
  • src/models.ts is the official mode catalog, Zod input/output schemas, and request-body builder.
  • src/clarity.ts is the Bun Shell curl client, result-URL parser, and optional download.
  • src/publish.ts turns local paths (and Dropbox/tmpfiles HTML pages) into raw public URLs via uguu, litterbox, or Tailscale Funnel.
  • src/env.ts loads this package's .env / .env.local even when cwd is elsewhere.
  • .grok/skills/clarity-upscale/SKILL.md is the companion agent skill.
  • scripts/smoke-test.ts is a local MCP client handshake (add --live for a real API call).
  • docs/copy.txt is a paste of the official API page. Treat it as the source of truth for modes and parameters.

Build, Test, And Run

  • Install with bun install.
  • Run the server with bun start or bun src/index.ts.
  • Tests: bun test.
  • Handshake: bun run smoke-test.
  • Live call: bun run smoke-test -- --live only when CLARITY_API_KEY is set and a paid upscale is intended.

Coding Conventions

  • Bun TypeScript, no tsc emit. Keep #!/usr/bin/env bun on the server and bin entry.
  • Use Bun Shell (import { $ } from "bun") for curl and mkdir. Always .quiet() so stdout stays MCP-only.
  • Use Bun.file / Bun.write / Bun.env / import.meta.dir instead of Node helpers when they fit.
  • Zod schemas for MCP input and output. Keep per-mode validation next to the schema it refines.
  • Return structuredContent plus a JSON text fallback.
  • Log diagnostics to stderr with console.error. Never write arbitrary stdout from the stdio server.

Clarity And Secrets

  • Never commit CLARITY_API_KEY, CAI_API_KEY, or .env.
  • Prefer CLARITY_API_KEY. Accept CAI_API_KEY as an alias.
  • CLARITY_BASE_URL, CLARITY_TIMEOUT, and CLARITY_OUTPUT_DIR are optional.
  • Changes to modes, parameter ranges, endpoint URL, or billing field names are user-visible.

Read the full file on GitHub · 50 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. 7d ago First seen · 50 lines · 682 tokens per session scan A 762ebec3e7a3

Subscribe to this mod's changes

clarity-api-mcp AGENTS.md is an instructions file published in the GitHub repository thomastraum/clarity-api-mcp (1 stars, last pushed 20d ago), licensed MIT. It adds 682 tokens to every session, about $0.0034 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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

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

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