Rayfin Documentation

Rayfin is a managed Backend-as-a-Service (BaaS) platform designed for the agentic era. It allows developers to define data models using TypeScript decorators, which the platform then uses to automatically provision and manage:

• Databases
• Authentication
• Data APIs
• Storage
• Hosting

Rayfin is built on Microsoft Fabric, providing enterprise-grade security, centralized data discovery, access control, and governance out of the box.

To use the type-safe client library for Data API Builder endpoints, install the @microsoft/rayfin-data package using npm.

npm install @microsoft/rayfin-data

You can install the Rayfin Model Context Protocol (MCP) tooling package using npm. This package provides MCP tooling for Rayfin.

npm install @microsoft/rayfin-mcp

You can quickly bootstrap a new Rayfin project using the @microsoft/create-rayfin scaffolding tool. The recommended way to use it is via npm create to ensure you are using the latest version.

npm create @microsoft/rayfin@latest

You can install the Rayfin platform command-line interface using npm. This package provides the CLI tools necessary to interact with the Rayfin platform.

npm install @microsoft/rayfin-cli

You can install the Rayfin docs indexing and search library using npm. This package is used for indexing and searching Rayfin documentation.

npm install @microsoft/rayfin-docs

You can install the @microsoft/rayfin-core TypeScript library, which is used for code-first Data API Builder configuration generation, using npm.

npm install @microsoft/rayfin-core

Rayfin uses GitHub Issues to track bugs, questions, and feature requests.

Before submitting a new issue:

1. Search existing issues: Check the open issues list to see if your problem or request has already been filed.
2. Engage with existing issues: If your issue already exists, do not create a duplicate. Instead, add relevant comments or use GitHub reactions to help engineers evaluate severity:
   • Use the :+1: reaction to upvote.
   • Use the :-1: reaction to downvote.

Submitting an issue:

• Use the provided issue templates to ensure you include the details necessary for engineers to reproduce the issue and conduct investigations.
• Note that issue review is periodic and does not follow a specific Service Level Agreement (SLA).

To use the Fabric brokered authentication provider for the Rayfin SDK, install the package via npm:

npm install @microsoft/rayfin-auth-provider-fabric

To use the Rayfin SDK authentication utilities in your project, install the @microsoft/rayfin-auth package using npm.

npm install @microsoft/rayfin-auth

If you prefer to install the scaffolding tool directly into your environment rather than using npm create, you can install it using the following command:

npm install @microsoft/create-rayfin