Skip to content
RailgridGet started
Menu

Your service.
Part of Railgrid.

Connect your service to Railgrid workspaces. Build the APIs, interfaces, and tools your users need.

One provider. Three ways to use it.

Create the same resource through the interface you prefer.

Example database provider

Create a database.

Engine
PostgreSQL
Size
Small

Values are fixed for this demonstration.

Apply a manifest.

apiVersion: databases.example.io/v1
kind: Database
metadata:
  name: app-dev
spec:
  engine: postgres
  size: small

Call an MCP tool.

“Create a small Postgres database called app-dev.”
create_database({
  "name": "app-dev",
  "engine": "postgres",
  "size": "small"
})

Workspace databases

0 databases

No database yet.

Choose an interface and create app-dev. Its details will appear here.

All three interfaces lead to the same resource.

You build A portal UI that creates a Database resource.

Railgrid connects Workspace context and routing for your UI.

Portal UI guide

You build The Database schema and the controller that provisions it.

Railgrid connects Your resource API to each enabled workspace.

Resource API guide

You build An MCP tool that creates the same Database resource.

Railgrid connects Tool discovery through the workspace MCP endpoint.

MCP guide

You build your service.

Your logic and the interfaces it needs.

Your provider runs independently. Build resource schemas, controllers, portal UI, and MCP handlers as your service needs them.

Explore extension points

Railgrid connects it.

Registration, workspace API bindings, routing, and MCP discovery.

How providers work

Start with a working provider.

The quickstart is a working hello provider, separate from the illustrative database demo above. Build it locally, change its hello response, and verify the new response in the portal.

Build the hello provider
  1. 01

    Build locally

    Run the provider and verify its hello response through the portal.

  2. 02

    Package and register

    Ship an image and chart; a hub administrator registers the provider.

  3. 03

    Enable in a workspace

    A workspace member accepts its declared permissions and enables its capabilities.

Add the interfaces your service needs.

Implement the parts your service calls for. Start with one and add others when they help.

What will you bring to Railgrid?

Contributing to Railgrid itself? Explore the core repository.