oiyai / docs
Developer tools

MCP server

Connect a compatible AI client to Oiy services, storage, and templates.

Build locally

Node.js 22 or later and a preview source checkout are required.

pnpm install
pnpm --filter @oiy-ai/mcp build
node packages/oiy-ai-mcp/dist/cli.js --help

The npm package is not yet published. Do not use npx @oiy-ai/mcp until a registry release is announced.

Configure your client

{
  "mcpServers": {
    "oiy-ai": {
      "command": "node",
      "args": ["/absolute/path/computing-center/packages/oiy-ai-mcp/dist/cli.js"]
    }
  }
}

Replace the path with your local build. Use your client's environment or secret store to pass OIY_API_KEY to the child process. The optional OIY_API_URL must be an HTTPS origin, except for loopback development.

The server uses stdio JSON-RPC. Catalog discovery works without a key; account operations require authentication.

Available tools

ToolPurpose
oiy_catalogRegions, availability, pricing, starter templates
oiy_templates / oiy_save_templateRead or save portable templates
oiy_billingFull-window summaries or bounded cursor-paginated ledger history
oiy_registries / oiy_save_registryRead metadata or save pull access using local secret-environment references
oiy_accountBalance and resource counts
oiy_servicesPaginated services or detail
oiy_create_service / oiy_update_serviceCreate or revision-check configuration
oiy_service_actionStart, stop, restart, resize
oiy_sleep_policyIdle sleep configuration
oiy_inspect_serviceBounded events, activity, and logs
oiy_metricsMonitoring status, observed-sample statistics, and optional bounded history
oiy_execBounded command execution
oiy_storageVolume lifecycle, ownership, and charges
oiy_create_volume / oiy_update_volumeCreate, rename, or expand independent storage
oiy_deleteDelete a service, volume, or template with ID confirmation

The oiy://guide resource explains lifecycle and storage behavior.

Review consequential actions

Tools can allocate billable compute or delete data. An AI client should obtain your intent before spending or deleting. Tool annotations and confirmation IDs assist review but do not grant authority.

Every state-changing intent needs a unique requestId (8–128 characters). Use the same key only for the identical retry after inspecting state. The client never automatically retries mutations or commands.

On this page