@harperfast/skills 1.0.0

package/AGENTS.md

@@ -0,0 +1,7 @@
+# Harper Agent Skills
+
+This repository contains "skills" that guide AI agents in developing Harper applications.
+
+## Available Skills
+
+- [Harper Best Practices](harper-best-practices/SKILL.md): Comprehensive guidelines for building, extending, and deploying Harper applications.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 HarperDB, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,26 @@
+# Harper Agent Skills
+
+This repository provides specialized "skills" for AI agents (like Cursor, Windsurf, or Junie) to build better applications on [Harper](https://harper.fast/).
+
+## Installation
+
+Add these skills to your local project using the [skills](https://skills.sh/) CLI:
+
+```bash
+npx skills add harperfast/skills
+```
+
+Re-run this command later if you want to get the latest updates from us.
+
+## Available Skills
+
+### [Harper Best Practices](harper-best-practices/SKILL.md)
+Comprehensive guidelines for building, extending, and deploying Harper applications. Covers:
+- Schema design and relationships.
+- Automatic REST and WebSocket APIs.
+- Custom resources and table extensions.
+- Advanced features like Vector Indexing and Caching.
+
+## How it Works
+
+These skills are structured to be easily consumed by Large Language Models (LLMs) and AI agents. For a technical overview of how agents use these files, see [AGENTS.md](AGENTS.md).

package/harper-best-practices/AGENTS.md

@@ -0,0 +1,258 @@
+# 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.
+
+---
+
+## Table of Contents
+
+1. [Schema & Data Design](#1-schema--data-design) — **HIGH**
+   - 1.1 [Adding Tables with Schemas](#11-adding-tables-with-schemas)
+   - 1.2 [Defining Relationships](#12-defining-relationships)
+   - 1.3 [Vector Indexing](#13-vector-indexing)
+   - 1.4 [Using Blobs](#14-using-blobs)
+   - 1.5 [Handling Binary Data](#15-handling-binary-data)
+2. [API & Communication](#2-api--communication) — **HIGH**
+   - 2.1 [Automatic REST APIs](#21-automatic-rest-apis)
+   - 2.2 [Querying REST APIs](#22-querying-rest-apis)
+   - 2.3 [Real-time Applications](#23-real-time-applications)
+   - 2.4 [Checking Authentication](#24-checking-authentication)
+3. [Logic & Extension](#3-logic--extension) — **MEDIUM**
+   - 3.1 [Custom Resources](#31-custom-resources)
+   - 3.2 [Extending Table Resources](#32-extending-table-resources)
+   - 3.3 [Programmatic Table Requests](#33-programmatic-table-requests)
+   - 3.4 [TypeScript Type Stripping](#34-typescript-type-stripping)
+   - 3.5 [Caching](#35-caching)
+4. [Infrastructure & Ops](#4-infrastructure--ops) — **MEDIUM**
+   - 4.1 [Deploying to Harper Fabric](#41-deploying-to-harper-fabric)
+   - 4.2 [Serving Web Content](#42-serving-web-content)
+
+---
+
+## 1. Schema & Data Design
+
+**Impact: HIGH**
+
+### 1.1 Adding Tables with Schemas
+
+Instructions for the agent to follow when adding tables to a Harper database.
+
+#### When to Use
+Use this skill when you need to define new data structures or modify existing ones in a Harper database.
+
+#### Steps
+1. **Create Dedicated Schema Files**: Prefer having a dedicated schema `.graphql` file for each table. Check the `config.yaml` file under `graphqlSchema.files` to see how it's configured. It typically accepts wildcards (e.g., `schemas/*.graphql`), but may be configured to point at a single file.
+2. **Use Directives**: All available directives for defining your schema are defined in `node_modules/harperdb/schema.graphql`. Common directives include `@table`, `@export`, `@primaryKey`, `@indexed`, and `@relationship`.
+3. **Define Relationships**: Link tables together using the `@relationship` directive. 
+4. **Enable Automatic APIs**: If you add `@table @export` to a schema type, Harper automatically sets up REST and WebSocket APIs for basic CRUD operations against that table. 
+5. **Consider Table Extensions**: If you are going to extend the table in your resources, then do not `@export` the table from the schema.
+
+#### Example
+```graphql
+type ExamplePerson @table @export {
+	id: ID @primaryKey
+	name: String
+	tag: String @indexed
+}
+```
+
+### 1.2 Defining Relationships
+
+Using the `@relationship` directive to link tables.
+
+#### When to Use
+Use this when you have two or more tables that need to be logically linked (e.g., a "Product" table and a "Category" table).
+
+#### Steps
+1. **Identify the Relationship**: Determine which table should "own" the relationship. This is typically the table that will hold the foreign key.
+2. **Apply the `@relationship` Directive**: In your GraphQL schema, use the `@relationship` directive on the field that links to another table.
+3. **Specify the `name` and `path` Arguments**:
+   - `name`: A unique name for the relationship.
+   - `path`: The field name in the current table that holds the value to match in the related table.
+4. **Define the Inverse Relationship (Optional but Recommended)**: For better queryability, define the relationship in the related table as well.
+
+#### Example
+```graphql
+type Product @table @export {
+    id: ID @primaryKey
+    name: String
+    category: Category @relationship(name: "product_category", path: "category_id")
+    category_id: ID
+}
+
+type Category @table @export {
+    id: ID @primaryKey
+    name: String
+    products: [Product] @relationship(name: "product_category", path: "id")
+}
+```
+
+### 1.3 Vector Indexing
+
+How to define and use vector indexes for efficient similarity search.
+
+#### When to Use
+Use this when you need to perform similarity searches on high-dimensional data, such as image embeddings, text embeddings, or any other numeric vectors.
+
+#### Steps
+1. **Define the Vector Field**: In your GraphQL schema, define a field with a list of floats (e.g., `[Float]`).
+2. **Apply the `@indexed` Directive**: Use the `@indexed` directive on the vector field and specify the index type as `vector`.
+3. **Configure the Index (Optional)**: You can provide additional configuration for the vector index, such as the distance metric (e.g., `cosine`, `euclidean`).
+4. **Querying**: Use the `vector` operator in your REST or programmatic requests to perform similarity searches.
+
+#### Example
+```graphql
+type Document @table @export {
+    id: ID @primaryKey
+    content: String
+    embedding: [Float] @indexed(type: "vector", options: { dims: 1536, metric: "cosine" })
+}
+```
+
+### 1.4 Using Blobs
+
+How to store and retrieve large data in HarperDB.
+
+#### When to Use
+Use this when you need to store large, unstructured data such as files, images, or large text documents that exceed the typical size of a standard database field.
+
+#### Steps
+1. **Define the Blob Field**: Use the `Blob` scalar type in your GraphQL schema.
+2. **Storing Data**: Send the data as a buffer or a stream when creating or updating a record.
+3. **Retrieving Data**: Access the blob field, which will return the data as a stream or buffer.
+
+### 1.5 Handling Binary Data
+
+How to store and serve binary data like images or MP3s.
+
+#### When to Use
+Use this when your application needs to handle binary files, particularly for storage and retrieval.
+
+#### Steps
+1. **Use the `Blob` type**: As with general large data, the `Blob` type is best for binary files.
+2. **Streaming**: For large files, use streaming to minimize memory usage during upload and download.
+3. **MIME Types**: Store the MIME type alongside the binary data to ensure it is served correctly by your application logic.
+
+---
+
+## 2. API & Communication
+
+**Impact: HIGH**
+
+### 2.1 Automatic REST APIs
+
+Details on the CRUD endpoints automatically generated for exported tables.
+
+#### Endpoints
+- `GET /{TableName}`: Describes the schema.
+- `GET /{TableName}/`: Lists records (supports filtering/sorting).
+- `GET /{TableName}/{id}`: Gets a record by ID.
+- `POST /{TableName}/`: Creates a record.
+- `PUT /{TableName}/{id}`: Updates a record.
+- `PATCH /{TableName}/{id}`: Partial update.
+- `DELETE /{TableName}/`: Deletes records.
+- `DELETE /{TableName}/{id}`: Deletes by ID.
+
+### 2.2 Querying REST APIs
+
+How to use filters, operators, sorting, and pagination in REST requests.
+
+#### Query Parameters
+- `limit`: Number of records to return.
+- `offset`: Number of records to skip.
+- `sort`: Field to sort by.
+- `order`: `asc` or `desc`.
+- `filter`: JSON object for filtering.
+
+### 2.3 Real-time Applications
+
+Implementing WebSockets and Pub/Sub for live data updates.
+
+#### When to Use
+Use this for applications that require live updates, such as chat apps, live dashboards, or collaborative tools.
+
+#### Steps
+1. **WebSocket Connection**: Connect to the Harper WebSocket endpoint.
+2. **Subscribing**: Subscribe to table updates or specific records.
+3. **Pub/Sub**: Use the internal bus to publish and subscribe to custom events.
+
+### 2.4 Checking Authentication
+
+How to use sessions to verify user identity and roles.
+
+#### When to Use
+Use this to secure your application by ensuring that only authorized users can access certain resources or perform specific actions.
+
+#### Steps
+1. **Session Handling**: Access the session object from the request context.
+2. **Identity Verification**: Check for the presence of a user ID or token.
+3. **Role Checks**: Verify if the user has the required roles for the action.
+
+---
+
+## 3. Logic & Extension
+
+**Impact: MEDIUM**
+
+### 3.1 Custom Resources
+
+How to define custom REST endpoints using JavaScript or TypeScript.
+
+#### Steps
+1. **Create Resource File**: Define your logic in a JS or TS file.
+2. **Export Handlers**: Export functions like `GET`, `POST`, etc.
+3. **Registration**: Ensure the resource is correctly registered in your application configuration.
+
+### 3.2 Extending Table Resources
+
+Adding custom logic to automatically generated table resources.
+
+#### Steps
+1. **Define Extension**: Create a resource file that targets an existing table.
+2. **Intercept Requests**: Use handlers to add custom validation or data transformation.
+3. **No `@export`**: If extending, remember not to `@export` the table in the schema.
+
+### 3.3 Programmatic Table Requests
+
+How to use filters, operators, sorting, and pagination in programmatic table requests.
+
+#### Usage
+When writing custom resources, use the internal API to query tables with full support for advanced filtering and sorting.
+
+### 3.4 TypeScript Type Stripping
+
+Using TypeScript directly without build tools via Node.js Type Stripping.
+
+#### Configuration
+Harper supports native TypeScript type stripping, allowing you to run `.ts` files directly. Ensure your environment is configured to take advantage of this for faster development cycles.
+
+### 3.5 Caching
+
+How caching is defined and implemented in Harper applications.
+
+#### Strategies
+- **In-memory**: For fast access to frequently used data.
+- **Distributed**: For scaling across multiple nodes in Harper Fabric.
+
+---
+
+## 4. Infrastructure & Ops
+
+**Impact: MEDIUM**
+
+### 4.1 Deploying to Harper Fabric
+
+Globally scaling your Harper application.
+
+#### Benefits
+- **Global Distribution**: Low latency for users everywhere.
+- **Automatic Sync**: Data is synced across the fabric automatically.
+- **Free Tier**: Start for free and scale as you grow.
+
+### 4.2 Serving Web Content
+
+Two ways to serve web content from a Harper application.
+
+#### Methods
+1. **Static Serving**: Serve HTML, CSS, and JS files directly.
+2. **Dynamic Rendering**: Use custom resources to render content on the fly.

package/harper-best-practices/SKILL.md

@@ -0,0 +1,88 @@
+---
+name: harper-best-practices
+description: 
+  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.
+license: MIT
+metadata:
+  author: harper
+  version: '1.0.0'
+---
+
+# 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
+
+## Steps
+
+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.
+
+## 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` - Define tables using GraphQL schemas and directives
+- `defining-relationships` - Link tables using the `@relationship` directive
+- `vector-indexing` - Efficient similarity search with vector indexes
+- `using-blob-datatype` - Store and retrieve large data (Blobs)
+- `handling-binary-data` - Manage binary data like images or MP3s
+
+### 2. API & Communication (HIGH)
+
+- `automatic-apis` - Leverage automatically generated CRUD endpoints
+- `querying-rest-apis` - Filters, sorting, and pagination in REST requests
+- `real-time-apps` - WebSockets and Pub/Sub for live data updates
+- `checking-authentication` - Secure apps with session-based identity verification
+
+### 3. Logic & Extension (MEDIUM)
+
+- `custom-resources` - Define custom REST endpoints using JS/TS
+- `extending-tables` - Add custom logic to generated table resources
+- `programmatic-table-requests` - Advanced filtering and sorting in code
+- `typescript-type-stripping` - Use TypeScript without build tools
+- `caching` - Implement and define caching for performance
+
+### 4. Infrastructure & Ops (MEDIUM)
+
+- `deploying-to-harper-fabric` - Scale globally with Harper Fabric
+- `serving-web-content` - Ways to serve web content from Harper
+
+## How to Use
+
+Read individual rule files for detailed explanations and code examples:
+
+```
+rules/adding-tables-with-schemas.md
+rules/automatic-apis.md
+```
+
+## Full Compiled Document
+
+For the complete guide with all rules expanded: `AGENTS.md`

package/harper-best-practices/rules/adding-tables-with-schemas.md

@@ -0,0 +1,40 @@
+---
+name: adding-tables-with-schemas
+description: Guidelines for adding tables to a Harper database using GraphQL schemas.
+---
+
+# Adding Tables with Schemas
+
+Instructions for the agent to follow when adding tables to a Harper database.
+
+## When to Use
+
+Use this skill when you need to define new data structures or modify existing ones in a Harper database.
+
+## Steps
+
+1. **Create Dedicated Schema Files**: Prefer having a dedicated schema `.graphql` file for each table. Check the `config.yaml` file under `graphqlSchema.files` to see how it's configured. It typically accepts wildcards (e.g., `schemas/*.graphql`), but may be configured to point at a single file.
+2. **Use Directives**: All available directives for defining your schema are defined in `node_modules/harperdb/schema.graphql`. Common directives include `@table`, `@export`, `@primaryKey`, `@indexed`, and `@relationship`.
+3. **Define Relationships**: Link tables together using the `@relationship` directive. For more details, see the [Defining Relationships](defining-relationships.md) skill.
+4. **Enable Automatic APIs**: If you add `@table @export` to a schema type, Harper automatically sets up REST and WebSocket APIs for basic CRUD operations against that table. For a detailed list of available endpoints and how to use them, see the [Automatic REST APIs](automatic-apis.md) skill.
+   - `GET /{TableName}`: Describes the schema itself.
+   - `GET /{TableName}/`: Lists all records (supports filtering, sorting, and pagination via query parameters). See the [Querying REST APIs](querying-rest-apis.md) skill for details.
+   - `GET /{TableName}/{id}`: Retrieves a single record by its ID.
+   - `POST /{TableName}/`: Creates a new record.
+   - `PUT /{TableName}/{id}`: Updates an existing record.
+   - `PATCH /{TableName}/{id}`: Performs a partial update on a record.
+   - `DELETE /{TableName}/`: Deletes all records or filtered records.
+   - `DELETE /{TableName}/{id}`: Deletes a single record by its ID.
+5. **Consider Table Extensions**: If you are going to [extend the table](./extending-tables.md) in your resources, then do not `@export` the table from the schema.
+
+### Example
+
+In a hypothetical `schemas/ExamplePerson.graphql`:
+
+```graphql
+type ExamplePerson @table @export {
+	id: ID @primaryKey
+	name: String
+	tag: String @indexed
+}
+```

package/harper-best-practices/rules/automatic-apis.md

@@ -0,0 +1,34 @@
+---
+name: automatic-apis
+description: How to use Harper's automatically generated REST and WebSocket APIs.
+---
+
+# Automatic APIs
+
+Instructions for the agent to follow when utilizing Harper's automatic APIs.
+
+## When to Use
+
+Use this skill when you want to interact with Harper tables via REST or WebSockets without writing custom resource logic. This is ideal for basic CRUD operations and real-time updates.
+
+## Steps
+
+1. **Enable Automatic APIs**: Ensure your GraphQL schema includes the `@export` directive for the table:
+   ```graphql
+   type MyTable @table @export {
+   	id: ID @primaryKey
+   	# ... other fields
+   }
+   ```
+2. **Access REST Endpoints**: Use the following endpoints for a table named `TableName` (Note: Paths are **case-sensitive**):
+   - **Describe Schema**: `GET /{TableName}`
+   - **List Records**: `GET /{TableName}/` (Supports filtering, sorting, and pagination. See [Querying REST APIs](querying-rest-apis.md)).
+   - **Get Single Record**: `GET /{TableName}/{id}`
+   - **Create Record**: `POST /{TableName}/` (Request body should be JSON).
+   - **Update Record (Full)**: `PUT /{TableName}/{id}`
+   - **Update Record (Partial)**: `PATCH /{TableName}/{id}`
+   - **Delete All/Filtered Records**: `DELETE /{TableName}/`
+   - **Delete Single Record**: `DELETE /{TableName}/{id}`
+3. **Use Automatic WebSockets**: Connect to `ws://your-harper-instance/{TableName}` to receive events whenever updates are made to that table. This is the easiest way to add real-time capabilities. For more complex needs, see [Real-time Applications](real-time-apps.md).
+4. **Apply Filtering and Querying**: Use query parameters with `GET /{TableName}/` and `DELETE /{TableName}/`. See the [Querying REST APIs](querying-rest-apis.md) skill for advanced details.
+5. **Customize if Needed**: If the automatic APIs don't meet your requirements, [customize the resources](./custom-resources.md).