Example

frameworks/openai/from-oai-typescript/.cursor/rules/agent.mdc

@@ -0,0 +1,36 @@
+---
+description: Guidelines for writing Agentuity AI Agents in TypeScript
+globs: "**/src/agents/**/index.ts"
+alwaysApply: true
+---
+
+# AI Agent File
+
+- Prefer using the `agentuity agent create` command to create a new Agent
+- Prefer loading types from the node modules package `@agentuity/sdk` in the node_modules folder
+- The file should export a default function
+- Prefer naming the default function Agent or the name of the Agent based on the context of the Agent description
+- All code should be in Typescript format
+- Use the provided logger from the `AgentContext` interface such as `ctx.logger.info("my message: %s", "hello")`
+
+## Example Agent File
+
+```typescript
+import type { AgentRequest, AgentResponse, AgentContext } from "@agentuity/sdk";
+
+export default async function Agent(req: AgentRequest, resp: AgentResponse, ctx: AgentContext) {
+	return resp.json({hello: 'world'});
+}
+```
+
+### AgentRequest
+
+The AgentRequest interface provides a set of helper methods and public variables which can be used for working with data has been passed to the Agent.
+
+### AgentResponse
+
+The AgentResponse interface provides a set of helper methods for responding with different data formats from the Agent.
+
+### AgentContext
+
+The AgentContext has information specific to the incoming Agent request and a set of helper methods for accessing AI services like KeyValue storage and Vector storage.

frameworks/openai/from-oai-typescript/.cursor/rules/agentuity.mdc

@@ -0,0 +1,9 @@
+---
+description: Guidelines for the Agentuity AI Configuration file
+globs: "agentuity.yaml"
+alwaysApply: true
+---
+
+# Agentuity Configuration File
+
+This file is used by Agentuity to configure the AI Agent project. You should NOT suggest edits to this file.

frameworks/openai/from-oai-typescript/.cursor/rules/sdk.mdc

@@ -0,0 +1,97 @@
+---
+description: Agentuity JavaScript SDK API Reference
+globs: "src/agents/**/*.ts"
+alwaysApply: false
+---
+
+# Agentuity JavaScript SDK
+
+The Agentuity JavaScript SDK provides a powerful framework for building AI agents in JavaScript and TypeScript. This cursor rules file helps you navigate the SDK's core interfaces and methods.
+
+## Core Interfaces
+
+### AgentHandler
+
+The main handler function type for an agent:
+
+```typescript
+type AgentHandler = (
+  request: AgentRequest,
+  response: AgentResponse,
+  context: AgentContext
+) => Promise<AgentResponseType>;
+```
+
+### AgentRequest
+
+The `AgentRequest` interface provides methods for accessing request data:
+
+- `request.trigger`: Gets the trigger type of the request
+- `request.metadata(key, defaultValue)`: Gets metadata associated with the request
+- `request.get(key, defaultValue)`: Gets the metadata value of the request
+- `request.data.contentType`: Gets the content type of the request payload
+- `request.data.json(): Promise<Json>`: Gets the payload as a JSON object
+- `request.data.text(): Promise<string>`: Gets the payload as a string
+- `request.data.buffer(): Promise<ArrayBuffer>`: Gets the payload as a ArrayBuffer
+- `request.data.binary(): Promise<ArrayBuffer>`: Gets the payload as a ArrayBuffer
+- `request.data.object<T>: Promise<T>`: Gets the payload as a typed object
+
+### AgentResponse
+
+The `AgentResponse` interface provides methods for creating responses:
+
+- `response.json(data, metadata)`: Creates a JSON response
+- `response.text(data, metadata)`: Creates a text response
+- `response.binary(data, metadata)`: Creates a binary response
+- `response.html(data, metadata)`: Creates an HTML response
+- `response.empty(metadata)`: Creates an empty response
+- `response.handoff(agent, args?)`: Redirects to another agent within the same project
+
+### AgentContext
+
+The `AgentContext` interface provides access to various capabilities:
+
+- `context.logger`: Logging functionality
+- `context.kv`: Key-Value storage
+- `context.vector`: Vector storage
+- `context.getAgent(params)`: Gets a handle to a remote agent
+- `context.tracer`: OpenTelemetry tracing
+
+## Storage APIs
+
+### Key-Value Storage
+
+Access through `context.kv`:
+
+- `context.kv.get(name, key)`: Retrieves a value
+- `context.kv.set(name, key, value, params)`: Stores a value with optional params (KeyValueStorageSetParams)
+- `context.kv.delete(name, key)`: Deletes a value
+
+### Vector Storage
+
+Access through `context.vector`:
+
+- `context.vector.upsert(name, ...documents)`: Inserts or updates vectors
+- `context.vector.search(name, params)`: Searches for vectors
+- `context.vector.delete(name, ...ids)`: Deletes vectors
+
+## Logging
+
+Access through `context.logger`:
+
+- `context.logger.debug(message, ...args)`: Logs a debug message
+- `context.logger.info(message, ...args)`: Logs an informational message
+- `context.logger.warn(message, ...args)`: Logs a warning message
+- `context.logger.error(message, ...args)`: Logs an error message
+- `context.logger.child(opts)`: Creates a child logger with additional context
+
+## Best Practices
+
+- Use TypeScript for better type safety and IDE support
+- Import types from `@agentuity/sdk`
+- Use structured error handling with try/catch blocks
+- Leverage the provided logger for consistent logging
+- Use the storage APIs for persisting data
+- Consider agent communication for complex workflows
+
+For complete documentation, visit: https://agentuity.dev/SDKs/javascript/api-reference

frameworks/openai/from-oai-typescript/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

frameworks/openai/from-oai-typescript/.gitignore

@@ -0,0 +1,39 @@
+# dependencies (bun install)
+node_modules
+
+# output
+out
+dist
+*.tgz
+
+# code coverage
+coverage
+*.lcov
+
+# logs
+logs
+_.log
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# caches
+.eslintcache
+.cache
+*.tsbuildinfo
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+# Agentuity
+.agentuity
+.agentuity-crash-*.json
+.env.development
+.env.production