Skip to main content

SDK Reference Overview

Welcome to the Grid SDK Reference. This section provides comprehensive API documentation for all exported primitives, services, and utilities in the Grid framework.

What You'll Find Here​

The SDK Reference is organized by category, providing detailed technical documentation for:

  • Conversation Primitives - Building blocks for conversation management
  • Services - Core services for LLM integration and orchestration
  • Factories - Factory functions for creating agents
  • Tools - Utilities for creating and managing tools
  • Types - TypeScript type definitions
  • Utilities - Helper functions and utilities

Documentation Format​

Each API reference page includes:

1. Overview​

A brief description of what the API does and when to use it.

2. Import Statement​

import { apiName } from "@mrck-labs/grid-core";

3. Function Signature​

Complete TypeScript signature with generics and parameter types.

4. Parameters​

Detailed documentation of all parameters including:

  • Type information
  • Default values
  • Optional vs required
  • Nested object properties

5. Return Type​

What the function returns, including:

  • Object methods and properties
  • Type definitions
  • Usage examples

6. Event Handlers​

For APIs that support events:

  • Available handlers
  • Handler signatures
  • When handlers are called

7. Examples​

Practical code examples showing:

  • Basic usage
  • Advanced patterns
  • Integration with other APIs

Most Used APIs​

Conversation Management​

Services​

Package Information​

All APIs documented here are exported from:

@mrck-labs/grid-core

Install with:

npm install @mrck-labs/grid-core

TypeScript Support​

Grid is written in TypeScript and provides full type definitions. All examples in this reference use TypeScript, but the library can be used with JavaScript as well.

Getting Help​

Contributing​

Found an issue or want to contribute to the documentation? Please open an issue or PR on our GitHub repository.