parksapi: Instructions file for GitHub Copilot

.github/copilot-instructions.md

parksapi copilot-instructions.md is an instructions file for GitHub Copilot from ThemeParks/parksapi. It costs 2,418 tokens per session, scanned A, original, MIT.

Project-specific review instructions for parksapi, a TypeScript library that collects live theme-park information such as wait times and schedules from more than 75 parks.

In plain words
What is it for?
Use them when reviewing or changing parksapi integrations, decorators, configuration defaults, or its shared destination classes.
Why use it?
They help code-review tools understand which patterns are intentional, so they do not report the project's normal design as defects.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md.

This is ThemeParks/parksapi's own configuration. It tells GitHub Copilot how to work on parksapi 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 parksapi configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is Authoritative source for conventions: [`CLAUDE.md`](../CLAUDE.md). This file is a Copilot-focused condensation; if there is a conflict, `CLAUDE.md` wins..

Reuse

Borrowing it

Nothing to install: this file belongs to ThemeParks/parksapi. 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/ThemeParks/parksapi/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/ThemeParks/parksapi

Made for: GitHub Copilot.

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 parksapi copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/themeparks/parksapi/copilot-instructions/github.svg)](https://agentmods.dev/instructions/themeparks/parksapi/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/themeparks/parksapi/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/themeparks/parksapi/copilot-instructions/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 parksapi copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/themeparks/parksapi/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/themeparks/parksapi/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,418 This file is loaded in full into every session.
When invoked 2,418 The same file — it is already loaded in full.
Security scan A 0 findings. 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.02418 $0.02418
Opus 5.5 $0.00967 $0.00967
Sonnet 5.5 $0.00484 $0.00484
Haiku 4.5 $0.00242 $0.00242

Measured 2mo ago against content hash 165eaf631161, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

parksapi copilot-instructions.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 2mo 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.

.github/copilot-instructions.md · 184 lines

How it starts

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

Copilot review instructions for parksapi

These instructions describe project-specific conventions. Do not flag the patterns below as defects — they are intentional. Use this file to calibrate review feedback before commenting.

Authoritative source for conventions: CLAUDE.md. This file is a Copilot-focused condensation; if there is a conflict, CLAUDE.md wins.

Project overview

parksapi is a TypeScript ESM library that fetches real-time theme park data (wait times, schedules, entities) from 75+ park implementations. All park integrations live under src/parks/<park>/. The core abstraction is the Destination base class with a Template Method pattern: subclasses implement _init(), buildEntityList(), buildLiveData(), buildSchedules(), plus override getDestinations() to declare the resort. The other public get*() methods (getEntities, getLiveData, getSchedules) must not be overridden.

Node 24+, npm 11+, ES2022 modules, decorators enabled.

Decorator-based design

Five decorators carry most of the framework:

Decorator Purpose
@destinationController({category}) Auto-registers the destination and applies @config to the class. Never apply @config to a class directly when using this decorator.
@config Property-level config injection. Values resolve from instance config → {CLASSNAME}_{PROP} env var → {PREFIX}_{PROP} env var → property default.
@cache({ttlSeconds, key?, callback?, cacheVersion?}) SQLite-backed memoisation with TTL.
@http({cacheSeconds?, retries?, ...}) Queue-based HTTP request wrapper.
@inject({eventName, hostname?, tags?, priority?}) Sift.js (MongoDB-like) event filter for cross-cutting concerns (auth, headers, error handling).

Patterns the project uses (do not flag these)

1. Empty-string config defaults are intentional

@config apiBase: string = '';
@config token: string = '';
@config email: string = '';

CLAUDE.md requires that no URLs, keys, tokens, or credentials ever appear hardcoded in source. Empty-string defaults force configuration via .env and are the documented convention. Do not suggest providing fallback URLs, default keys, or upfront validation that throws on empty strings. The HTTP layer's URL-construction error is the documented failure signal when env vars are missing.

Read the full file on GitHub · 184 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. 2mo ago First seen · 184 lines · 2,418 tokens per session scan A 165eaf631161

Subscribe to this mod's changes

parksapi copilot-instructions.md is an instructions file published in the GitHub repository ThemeParks/parksapi (143 stars, last pushed yesterday), licensed MIT. It adds 2,418 tokens to every session, about $0.0097 per session on Opus 5.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-30.

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens