harper-best-practices
Best practices for building Harper applications, covering schema definition, automatic APIs, authentication, custom resources, and data handling. Triggers on tasks involving Harper database design, API implementation, and deployment.
What this skill does
# Harper Best Practices Guidelines for building scalable, secure, and performant applications on Harper. These practices cover everything from initial schema design to advanced deployment strategies. ## When to Use Reference these guidelines when: - Defining or modifying database schemas - Implementing or extending REST/WebSocket APIs - Handling authentication and session management - Working with custom resources and extensions - Optimizing data storage and retrieval (Blobs, Vector Indexing) - Deploying applications to Harper Fabric ## How It Works 1. Review the requirements for the task (schema design, API needs, or infrastructure setup). 2. Consult the relevant category under "Rule Categories by Priority" to understand the impact of your decisions. 3. Apply specific rules from the "Quick Reference" section below by reading their detailed rule files. 4. If you're building a new table, prioritize the `schema-` rules. 5. If you're extending functionality, consult the `logic-` and `api-` rules. 6. Validate your implementation against the `ops-` rules before deployment. ## Examples See the concrete examples embedded in each rule subsection below (GraphQL schemas, REST query patterns, and deployment workflow snippets). <!-- BEGIN GENERATED INDEX --> ## Rule Categories by Priority | Priority | Category | Impact | Prefix | | -------- | -------------------- | ------ | --------- | | 1 | Schema & Data Design | HIGH | `schema-` | | 2 | API & Communication | HIGH | `api-` | | 3 | Logic & Extension | MEDIUM | `logic-` | | 4 | Infrastructure & Ops | MEDIUM | `ops-` | ## Quick Reference ### 1. Schema & Data Design (HIGH) - `adding-tables-with-schemas` — Guidelines for adding tables to a Harper database using GraphQL schemas. - `schema-design-tooling` — Best practices for Harper schema design, including core directives and GraphQL tooling configuration. - `defining-relationships` — How to define and use relationships between tables in Harper using GraphQL. - `vector-indexing` — How to enable and query vector indexes for similarity search in Harper. - `using-blob-datatype` — How to use the Blob data type for efficient binary storage in Harper. - `handling-binary-data` — How to store and serve binary data like images or audio in Harper. ### 2. API & Communication (HIGH) - `automatic-apis` — How to use Harper's automatically generated REST and WebSocket APIs. - `querying-rest-apis` — How to use query parameters to filter, sort, and paginate Harper REST APIs. - `real-time-apps` — How to build real-time features in Harper using WebSockets and Pub/Sub. - `checking-authentication` — How to handle user authentication and sessions in Harper Resources. ### 3. Logic & Extension (MEDIUM) - `custom-resources` — How to define custom REST endpoints with JavaScript or TypeScript in Harper. - `extending-tables` — How to add custom logic to automatically generated table resources in Harper. - `programmatic-table-requests` — How to interact with Harper tables programmatically using the `tables` object. - `typescript-type-stripping` — How to run TypeScript files directly in Harper without a build step. - `caching` — How to implement integrated data caching in Harper from external sources. ### 4. Infrastructure & Ops (MEDIUM) - `deploying-to-harper-fabric` — How to deploy a Harper application to the Harper Fabric cloud. - `creating-a-fabric-account-and-cluster` — How to create a Harper Fabric account, organization, and cluster. - `creating-harper-apps` — How to initialize a new Harper application using the CLI. - `serving-web-content` — How to serve static files and integrated Vite/React applications in Harper. - `logging` — Best practices for logging in Harper, including console capture, the granular logger interface, and programmatic log retrieval. - `load-env` — How to load environment variables from .env files into a Harper application using the loadEnv plugin. <!-- END GENERATED INDEX --> ## How to Use Read individual rule files for detailed explanations and code examples: ``` rules/adding-tables-with-schemas.md rules/schema-design-tooling.md rules/automatic-apis.md rules/creating-harper-apps.md rules/logging.md ``` ## Full Compiled Document For the complete guide with all rules expanded: `AGENTS.md`
Related in Design
contribute
IncludedLocal-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".
architectural-analysis
IncludedUser-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).
mcp
IncludedModel Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.
react-native-skia
IncludedDesign, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.
plaid
IncludedProduct Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".
nextjs-framer-motion-animations
IncludedAdds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.