Introduction to Piri Docs

Spatial database docs are now part of the admin UI under a single `/docs/*` route tree.

Overview

Piri documentation is organized like an operator console: concrete entry points on the left, dense implementation notes in the middle, and fast handoff between setup, guides, and API reference.

Concepts

travel_explore

R-tree Indexing

High-performance spatial indexing for fast geographic and geometric queries.

smart_toy

MCP-native

Built to plug directly into agent workflows through deterministic spatial tools.

chat

Natural Language Queries

Translate plain English prompts into concrete spatial operations and result sets.

Agentic Tools

docs_overview.json

{
  "tool_name": "docs_overview",
  "scope": "Documentation",
  "description": "Documentation",
  "parameters": {
    "workspace": "default",
    "surface": "docs-home",
    "focus": "Piri Docs",
    "mode": "reference"
  }
}

Implementation

docs_guides.ts

import { PiriClient } from '@piri/sdk'

const client = new PiriClient({
  apiKey: process.env.PIRI_API_KEY!,
  baseUrl: process.env.PIRI_BASE_URL!,
})

async function runDocsFlow() {
  const result = await client.request('/v1/workflows', {
    method: 'POST',
    body: {
      page: 'Piri Docs',
      section: 'Documentation',
      intent: 'load'
    }
  })

  return result
}

runDocsFlow().then(console.log)