mcp AGENTS.md

Project instructions for a Piwik PRO MCP server, a connector that exposes Piwik PRO analytics functions to an AI assistant. They cover setup, code structure, configuration, tests, and communication methods.

In plain words
What is it for?
Use them when setting up the project, adding or modifying analytics tools, updating configuration, and running its tests, linting, and formatting checks.
Why use it?
They give contributors the commands and architectural rules needed to change the server safely and verify that it still works.

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

Made for: Codex, OpenCode.

Per session 828 This file is loaded in full into every session.
When invoked 828 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.00828 $0.00828
Opus 5 $0.00414 $0.00414
Sonnet 5 $0.00166 $0.00166
Haiku 4.5 $0.00083 $0.00083

Measured 2d ago against content hash 68323107f04a, 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 · 44 lines

How it starts

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

Setup & Verify

  • Use uv for everything. Install deps with uv sync --dev.
  • Python requirement is >=3.12.
  • Run the server with uv run python -m piwik_pro_mcp.server or uv run piwik-pro-mcp.
  • Match CI before finishing: uv run pytest -v --tb=short, uv run ruff check . --config pyproject.toml, then uv run ruff format --check . --config pyproject.toml.
  • For focused checks, tests live under src/piwik_pro_mcp/tests, so use commands like uv run pytest src/piwik_pro_mcp/tests/test_server.py::TestMain::test_main_defaults_to_stdio_transport -v.

Architecture

  • This is a single Python package rooted at src/piwik_pro_mcp.
  • Main entrypoint and CLI wiring live in src/piwik_pro_mcp/server.py.
  • Public package layout is split mainly across api/, common/, tools/, assets/, and tests/ under src/piwik_pro_mcp/.
  • MCP tool registration is centralized in src/piwik_pro_mcp/tools/__init__.py; add new registrations there via the domain register_* function.
  • Environment-driven behavior is centralized in src/piwik_pro_mcp/common/settings.py.
  • Runtime schema discovery for JSON-style tool attributes is tools_parameters_get in src/piwik_pro_mcp/tools/parameters.py.

Configuration

  • Required env vars: PIWIK_PRO_HOST, PIWIK_PRO_CLIENT_ID, PIWIK_PRO_CLIENT_SECRET.
  • Optional env vars commonly affecting behavior: PIWIK_PRO_SAFE_MODE, PIWIK_PRO_TELEMETRY, PIWIK_PRO_TM_RESOURCE_CHECK, PIWIK_PRO_HTTP_ALLOWED_HOSTS.
  • .env files are supported via python-dotenv.

Behavioral Gotchas

  • Safe mode is on by default. filter_write_tools() removes any tool without annotations.readOnlyHint=True, so read-only tools must be annotated correctly or they disappear from the exposed server.
  • src/piwik_pro_mcp/tests/test_integration.py is the enforced inventory of registered tools. When adding or removing tools, update the READ_ONLY_TOOLS or WRITE_TOOLS lists there.
  • Settings helpers in common/settings.py use @cache. Tests that patch PIWIK_PRO_SAFE_MODE, PIWIK_PRO_TELEMETRY, PIWIK_PRO_TM_RESOURCE_CHECK, or PIWIK_PRO_HTTP_ALLOWED_HOSTS must clear caches before and after, following src/piwik_pro_mcp/tests/conftest.py, src/piwik_pro_mcp/tests/common/test_settings.py, and src/piwik_pro_mcp/tests/test_telemetry.py.
  • If a tool accepts free-form attributes, keep its tools_parameters_get schema path working and add or maintain the corresponding MCP tests under src/piwik_pro_mcp/tests/tools/.

Read the full file on GitHub · 44 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 · 44 lines · 828 tokens per session scan A 68323107f04a

Subscribe to this mod's changes

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