rubiks-cube-solver: Instructions file for GitHub Copilot

.github/instructions/api-boundary.instructions.md

rubiks-cube-solver api-boundary.instructions.md is an instructions file for GitHub Copilot from williamisnotdefined/rubiks-cube-solver. It costs 3,019 tokens per session, scanned A, original, MIT.

Guidance for the boundary between the cube solver and its web API, including routes, data contracts, validation, solver loading, scan sessions, and the matching browser client. An API is the defined way software exchanges requests and responses.

In plain words
What is it for?
Use it when changing Axum routes, request or response contracts, validation, solver loading, scan sessions, or the related web API client.
Why use it?
It keeps cube rules in the Rust engine while the server handles HTTP behavior and the browser uses matching, checked data.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

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

Reuse

Borrowing it

Nothing to install: this file belongs to williamisnotdefined/rubiks-cube-solver. 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/williamisnotdefined/rubiks-cube-solver/main/.github/instructions/api-boundary.instructions.md
Clone the repo
git clone --depth 1 https://github.com/williamisnotdefined/rubiks-cube-solver

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 rubiks-cube-solver api-boundary.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary/github.svg)](https://agentmods.dev/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary)
Your own site
<a href="https://agentmods.dev/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary"><img src="https://agentmods.dev/badge/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary/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 rubiks-cube-solver api-boundary.instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary"><img src="https://agentmods.dev/badge/instructions/williamisnotdefined/rubiks-cube-solver/api-boundary.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,019 This file is loaded in full into every session.
When invoked 3,019 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.03019 $0.03019
Opus 5.5 $0.01208 $0.01208
Sonnet 5.5 $0.00604 $0.00604
Haiku 4.5 $0.00302 $0.00302

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

Security

Grade A, and why

rubiks-cube-solver api-boundary.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/instructions/api-boundary.instructions.md · 205 lines

How it starts

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

Generated from ai/registry.json. Do not edit manually.

Canonical skill: ../../ai/skills/api-boundary.md.

Referenced context:

  • ../../ai/rules/api-rules.md
  • ../../ai/rules/frontend-rules.md
  • ../../ai/rules/testing-rules.md
  • ../../ai/architecture/api-boundary.md

This file is compiled from canonical AI knowledge files. Edit canonical files under ai, then run npm run ai:sync.

Compiled AI Skill: api-boundary

Canonical Skill: ai/skills/api-boundary.md

API Boundary

Use for Axum routes, contracts, validation, solver loading, scan sessions, or the matching web API client.

Read First

  • ai/rules/api-rules.md
  • ai/rules/frontend-rules.md
  • ai/rules/testing-rules.md
  • ai/architecture/api-boundary.md

Workflow

  • Inspect the focused route/response/solve modules and matching client contract.
  • Keep engine semantics in Rust, HTTP limits and status mapping in Axum, and normalization in the web API domain.
  • Preserve typed scan stickers and the server-side 308 WCA docs redirect where affected.
  • Run API tests plus web tests/build when the browser contract changes.

Referenced Context

Reference: ai/rules/api-rules.md

API Rules

Rules for the Axum HTTP API and the frontend API contract.

Always

  • Keep route handlers thin: extract state and JSON, validate request limits, choose the solver strategy, delegate to Rust engine code, and map results to HTTP responses.
  • Keep solver behavior in cube-engine; crates/api owns HTTP shape, safety limits, generated-solver loading, CORS, and error/status mapping.
  • Use Serde request and response structs as the API contract.
  • Keep notation solve requests on move notation and route scan solves through typed scan-session contracts, which MAY include reviewed stickers and manual overrides.
  • Validate API safety limits before parsing notation or invoking search.
  • Use named constants for public API caps such as maximum depth, maximum nodes, notation bytes, and JSON body bytes.
  • Preserve stable response status strings, error kinds, and metadata fields because apps/web/src/api normalizes them.
  • Verify returned solutions by replay before reporting success.
  • Keep generated pruning-table availability and corruption errors explicit in API responses.
  • Keep CORS origins narrow to known local web development and preview origins unless deployment requirements change.
  • Update apps/web/src/api types and normalization when API response fields or status values change.
  • Keep /api/wca-data as an Axum HTTP 308 redirect to /api/wca-data/v1/docs; WCA data endpoints belong to apps/wca-data.

Read the full file on GitHub · 205 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 · 205 lines · 3,019 tokens per session scan A 31562d4b36c2

Subscribe to this mod's changes

rubiks-cube-solver api-boundary.instructions.md is an instructions file published in the GitHub repository williamisnotdefined/rubiks-cube-solver (5 stars, last pushed 4d ago), licensed MIT. It adds 3,019 tokens to every session, about $0.0121 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-31.

Related

rubiks-cube-solver api-boundary.instructions.md compared with instructions from other repositories

rubiks-cube-solver api-boundary.instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
rubiks-cube-solver api-boundary.instructions.mdwilliamisnotdefined/rubiks-cube-solverInstructions file54d agoMITA3,019GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode