docs/overview.mdx

Rama main · réplica de lectura del repositorio original.

---
title: API reference
description: Find Cotal CLI commands, agent tools, configuration fields, and data models.
kind: Reference
audience: operators and integrators
---

import { Card, Cards } from 'fumadocs-ui/components/card';

Use the CLI from a terminal or the `cotal_*` tools inside a connected agent session.
These references describe the TypeScript implementation.
The [wire specification](../SPEC.md) defines the protocol.

## Commands

<Cards>
  <Card title="CLI reference" href="cli.mdx">
    Look up command syntax, flags, receipts, and limits by topic.
  </Card>
  <Card title="MCP tool catalog" href="mcp-tools.mdx">
    Look up tool arguments, availability, and effects on the mesh.
  </Card>
</Cards>

## Configuration

<Cards>
  <Card title="Agent files" href="agent-files.mdx">
    Define a persona's identity, model, capabilities, and channel access.
  </Card>
  <Card title="Mesh manifest" href="manifest.mdx">
    Look up the fields in a cotal.yaml team definition.
  </Card>
  <Card title="Configuration" href="config.mdx">
    Find workstation preferences, environment variables, and storage paths.
  </Card>
  <Card title="Channels and permissions" href="channels-and-permissions.mdx">
    Look up read, publish, and channel-administration permissions.
  </Card>
</Cards>

## Models

<Cards>
  <Card title="MeshView" href="mesh-view.mdx">
    Look up terminal observer data, events, and membership state.
  </Card>
  <Card title="cotal-lang card" href="lang-card.mdx">
    Look up workflow effects, results, and common refusals.
  </Card>
  <Card title="Glossary" href="glossary.mdx">
    Find definitions of protocol and implementation terms.
  </Card>
</Cards>

## TypeScript packages

<Cards>
  <Card title="TypeScript reference" href="https://docs.cotal.ai/api/typescript/">
    Look up the declarations each published package exports, generated from its source.
  </Card>
</Cards>

## HTTP interfaces

[Integration interfaces](api-reference.mdx) explains which API fits a client.
The [Auth HTTP reference](auth-api.mdx) covers authority operations.
The [Dashboard HTTP reference](dashboard-api.mdx) covers browser and automation reads.
Both publish portable OpenAPI specifications and operation-level Markdown.