Inicio rápido

2 min de lectura

Inicio rápido

Ten una API JSON-RPC funcionando desde tu base de datos PostgreSQL en menos de un minuto. Tu base de datos es tu backend — sin framework, sin código repetitivo.

1. Instalación

Descarga un binario

# macOS (Homebrew)
brew install heptau/tap/pgarachne

# o descarga la última versión para tu sistema:
#   https://github.com/heptau/pgarachne/releases/latest

2. Prepara tu base de datos

Crea una base de datos y carga el esquema de PgArachne:

createdb my_database
psql -d my_database -f sql/schema.sql

3. Configura y ejecuta

Crea un archivo pgarachne.env (el servidor lo encuentra en el directorio actual):

DB_HOST=localhost
DB_PORT=5432
DB_USER=pgarachne
JWT_SECRET=$(openssl rand -hex 32)

Inicia el servidor:

./pgarachne

4. Define una función

En tu base de datos, crea un rol y una función. El comentario SQL de la función la documenta para los LLM.

CREATE ROLE demo_user WITH LOGIN PASSWORD 'user_password';
GRANT USAGE ON SCHEMA api TO demo_user;

CREATE OR REPLACE FUNCTION api.hello_world(payload jsonb)
RETURNS json LANGUAGE sql AS $$
    SELECT '"Hello World"'::json;
$$;
GRANT EXECUTE ON FUNCTION api.hello_world(jsonb) TO demo_user;

5. Llamada

Tu endpoint de API está en vivo:

curl -X POST http://localhost:8080/db/my_database/jsonrpc \
  -u demo_user:user_password \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"api.hello_world","params":{},"id":1}'
# → {"jsonrpc":"2.0","result":"Hello World","id":1}

6. Conecta un agente de IA (MCP)

Expón las mismas funciones a Claude Desktop o Cursor como herramientas mediante el endpoint MCP:

POST http://localhost:8080/db/my_database/mcp

Ver MCP (Model Context Protocol) para instrucciones completas de conexión.

Eso es todo. Lee la guía Hello World para el flujo de autenticación JWT, o la comparación con PostgREST para entender dónde encaja PgArachne.

Documentación relacionada

← Comparación con PostgREST Instalación →