hamster-mcp AGENTS.md

hamster-mcp AGENTS.md is an instructions file for Codex, OpenCode from altendky/hamster-mcp. It costs 636 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for developing and checking a Python project managed with mise and uv. They describe setup, formatting, linting, type checking, tests, and how brand icons are generated from an SVG source.

In plain words
What is it for?
Use them to set up the project, run its formatter, linter, type checker, and tests, install dependencies, and regenerate its icons.
Why use it?
They prevent developers from using the wrong Python environment or installing dependencies incorrectly, which can cause inconsistent results between machines and CI.

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/altendky/hamster-mcp/agents-md.svg)](https://agentmods.dev/instructions/altendky/hamster-mcp/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/altendky/hamster-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/altendky/hamster-mcp/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 636 This file is loaded in full into every session.
When invoked 636 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.00636 $0.00636
Opus 5 $0.00318 $0.00318
Sonnet 5 $0.00127 $0.00127
Haiku 4.5 $0.00064 $0.00064

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

Security

Grade A, and why

hamster-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 5d 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 · 75 lines

How it starts

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

AI Agent Context

For project requirements, architecture, and conventions, see:

Development Workflow

Setup

mise install          # Installs Python 3.14, uv, pre-commit, and project tools
uv sync --extra dev   # Creates .venv, installs package + dev deps
pre-commit install    # Installs git hooks

Running checks

ruff format --check .   # Formatting
ruff check .            # Linting
mypy                    # Type checking
pytest src/             # Tests

Rules

  • Always use the mise-managed environment. Run python, ruff, mypy, pytest, etc. from the mise-activated shell or via mise run. Never set PYTHONPATH manually.
  • Install via uv sync, not pip install. The project uses uv.lock for deterministic dependency resolution.
  • Do not modify uv.lock by hand. It is generated by uv lock and updated by uv sync.

Icon generation

Brand icons are generated from brand/source.svg:

mise run generate-icons

The source SVG should contain black stroke-based line art with uniform stroke width. The script applies amber (#c87f43) fill and halo (3x stroke width), auto-fits to the canvas, then exports PNG icons at 256x256 and 512x512.

Generated files (written to custom_components/hamster_mcp/brand/):

Code Conventions

  • Dataclasses everywhere. All classes use @dataclass. Prefer @dataclass(frozen=True, slots=True) for immutability; use explicit frozen=False when mutation is needed. Use .create() classmethods for complex construction. See Principles for details and exception criteria.

Package Structure

  • src/hamster_mcp/mcp/_core/ --- sans-IO protocol core. Must not perform I/O or hold global state. May depend on any library as long as the code itself remains pure.
  • src/hamster_mcp/mcp/_io/ --- I/O adapters (async transport). Does not import homeassistant (HA-independent for testability).
  • src/hamster_mcp/component/ --- HA integration. May import anything.
  • custom_components/hamster_mcp/ --- HACS deployment shim. Thin re-exports from hamster_mcp.component.

Read the full file on GitHub · 75 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. 5d ago First seen · 75 lines · 636 tokens per session scan A 31335fdc7f33

Subscribe to this mod's changes

hamster-mcp AGENTS.md is an instructions file published in the GitHub repository altendky/hamster-mcp (5 stars, last pushed 3d ago), licensed Apache-2.0. It adds 636 tokens to every session, about $0.0032 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.