ireland-mcp
AGENTS.md2 starsChanged 19 days agoMITView on GitHub
Ireland MCP is a read-only Model Context Protocol server for Irish public data. See CONTRIBUTING.md for the full contributor guide. Node 22.12 or later. npm run live:sanity and npm run live:all call real upstream services. Run them by hand; they are not part of PR CI (the nightly live-smoke workflow runs live:sanity). - Tools are read-only, named {source}_{verb}, and return an evidence envelope with source, URL, licence, attribution and retrieval time. - Bound every list and throw ToolError with a…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository27 other files it gives its agents.
- web/AGENTS.mdAGENTS.md
- web/llms.txtllms.txt
- commute-weatherSkill
- compare-two-areasSkill
- council-budget-compareSkill
- cso-chartSkill
- derelict-and-vacancySkill
- energy-and-grid-explainerSkill
- eu-funding-finderSkill
- flood-watchSkill
- grid-nowSkill
- house-price-checkSkill
- housing-supply-trackerSkill
- irish-area-reportSkill
- legislation-lookupSkill
- lobbying-watchSkill
- local-election-briefSkill
- oireachtas-trackerSkill
- open-data-finderSkill
- pay-gap-compareSkill
- planning-and-heritage-near-meSkill
- public-money-trackerSkill
- rights-checkSkill
- safety-statsSkill
- td-briefingSkill
- transport-reliability-checkSkill
- where-to-live-shortlistSkill
The file
We split this AGENTS.md into the rules it gives an agent
6 rules. About 1 is common, 4 are distinctive, and 1 is very specific to this project.
≈1
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 41
Write the failing test first for new behaviour.
- Distinctive: line 43
Do not claim live coverage, deployment or passing checks without evidence.
- Common: line 44
Never commit secrets, tokens, subscription IDs or personal paths.
- Distinctive: line 45
If a check cannot run locally (missing dependency, restricted sockets), say so rather than skipping it silently.
- Distinctive: line 53
Use fixed official URLs, bounded reads and explicit response validation.
- Very specific: line 58
Add a bounded case to scripts/live-sanity.mjs (environment-gated if it needs an operator key).
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Guidance for contributors and coding agents
Ireland MCP is a read-only Model Context Protocol server for Irish public data. See CONTRIBUTING.md for the full contributor guide.
Commands
Node 22.12 or later.
npm ci
npm run typecheck
npm run lint
npm test # unit tests replay fixtures, no network
npm run build
npm run inspector:check # MCP conformance via the Inspector CLI (after build)
npm run dev:http # local server on http://localhost:7071
npm run legal:check # legal corpus package checksnpm run live:sanity and npm run live:all call real upstream services. Run
them by hand; they are not part of PR CI (the nightly live-smoke workflow runs
live:sanity).
Layout
src/gateway/: envelope, errors, caching and tool definition helperssrc/sources/<id>/: one module per upstream source, with fixtures and testssrc/registry.ts: registers source modulespackages/irish-legal-mcp/: optional legal and Citizens Information pilot corpusweb/: static site;storybook/: component previewsskills/: packaged user-facing skills;infra/: Azure infrastructure as codedocs/: deployment, operations and evidence notes
Conventions
- Tools are read-only, named
{source}_{verb}, and return an evidence envelope with source, URL, licence, attribution and retrieval time. - Bound every list and throw
ToolErrorwith a hint. Never build an upstream URL from a user-supplied host. - Write the failing test first for new behaviour.
- Preserve source attribution and legal-currentness warnings.
- Do not claim live coverage, deployment or passing checks without evidence.
- Never commit secrets, tokens, subscription IDs or personal paths.
- If a check cannot run locally (missing dependency, restricted sockets), say so rather than skipping it silently.
CI enables LEGAL_SOCKET_TESTS=1 and runs lint, typecheck, tests, the build and
the Inspector conformance check.
Reviewing a new source
- Use fixed official URLs, bounded reads and explicit response validation. An empty or malformed response must not become valid zero data or enter the cache.
- Preserve publisher attribution, reporting dates, retrieval dates, missing values, stale state and transfer-limit flags. A local or fixture check is not hosted verification.
- Add a bounded case to
scripts/live-sanity.mjs(environment-gated if it needs an operator key).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.