ha-mcp-readonly: Instructions file for Codex

AGENTS.md

ha-mcp-readonly AGENTS.md is an instructions file for Codex, OpenCode from paulomac1000/ha-mcp-readonly. It costs 4,471 tokens per session, scanned A, original, MIT.

A project instruction file for agents working on HA-MCP-Readonly. It sets rules for language, naming, documentation, tests, and tool descriptions.

In plain words
What is it for?
Use it when adding or changing tools, tests, or documentation in the HA-MCP-Readonly project.
Why use it?
It gives contributors one shared set of engineering and testing rules, reducing inconsistent code and review problems.

Instructions file for CodexOpenCode

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

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

Reuse

Borrowing it

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

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 ha-mcp-readonly AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/paulomac1000/ha-mcp-readonly/agents-md"><img src="https://agentmods.dev/badge/instructions/paulomac1000/ha-mcp-readonly/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 4,471 This file is loaded in full into every session.
When invoked 4,471 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.04471 $0.04471
Opus 5 $0.02235 $0.02235
Sonnet 5 $0.00894 $0.00894
Haiku 4.5 $0.00447 $0.00447

Measured 9d ago against content hash 8ce2eeaa21db, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

ha-mcp-readonly 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 9d 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.

2. **Test with `curl`** + LLAT on a real HA instance:
AGENTS.md · 376 lines

How it starts

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

Agent Instructions — HA-MCP-Readonly

Read before writing any tool, test, or documentation.

Language & Naming

Mandatory English

  • ALL code, comments, docstrings, commit messages, and tool descriptions MUST be in English.
  • No Polish, no mixed-language fragments (np.e.g., ZamiastInstead of).
  • No Polish characters (ą, ę, ś, ć, ń, ó, ł, ż, ź) in source files.

Generic Names Only

  • Use generic, non-culture-specific names in examples and test fixtures:
    • light.living_room not light.salon
    • area_id="office" not area_id="biuro"
    • person.test_user not person.pawel
    • zone.home, zone.work not culture-specific zone names
  • Mock data in tests/fixtures.py uses: living_room, office, bedroom

Tool Descriptions

  • First line of @mcp.tool() docstring MUST be a complete sentence describing what the tool does.
  • NO emoji in tool description first lines.
  • NO emoji in API response strings (status labels, messages).
  • Public tool/function docstrings MUST include meaningful Args and Returns sections when the callable accepts arguments or returns a value; module, class, and exception docstrings MUST NOT contain empty placeholder sections.
  • Use plain text status labels: "OK" not "✅ OK", "FAILED" not "❌ FAILED".

Parameter Descriptions

  • Use e.g. not np. for examples.
  • Examples must use generic entity IDs: light.living_room, sensor.temperature, person.test_user.

Test Standards

Test Hierarchy

Suite Location Runtime Requires Run with
Unit tests/unit/ <20s Nothing pytest tests/unit/ -q
Smoke tests/smoke/ <5s REST API (ports 9092/9093) + HA_TOKEN pytest tests/smoke/ -q
Integration tests/integration/ ~2min Real HA + HA_TOKEN pytest tests/integration/ -q
E2E tests/e2e/ ~30s Real HA + REST API + HA_TOKEN pytest tests/e2e/ -q

Read the full file on GitHub · 376 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. 9d ago First seen · 376 lines · 4,471 tokens per session scan A 8ce2eeaa21db

Subscribe to this mod's changes

ha-mcp-readonly AGENTS.md is an instructions file published in the GitHub repository paulomac1000/ha-mcp-readonly (43 stars, last pushed 6d ago), licensed MIT. It adds 4,471 tokens to every session, about $0.0224 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-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