# YAMS API Documentation

A concise index for YAMS programmatic interfaces (MCP tools + plugin interfaces).

## What’s here

- MCP / CLI-facing API docs (available now):
  - [MCP Tools](./mcp_tools.md)
  - [Graph Adapter v1](./graph_adapter_v1.md)
  - [Storage Plugin v1](./storage_plugin_v1.md)

If you’re integrating YAMS today, start with the MCP tools and CLI reference.

## TL;DR

- MCP tools:
  - See [MCP Tools](./mcp_tools.md) for the tool surface (names, args, responses).
- CLI:
  - See `../user_guide/cli.md` for command-line automation.

## Quick usage patterns

- For AI / tool integrations, use MCP tools (see `docs/user_guide/mcp.md` + `docs/api/mcp_tools.md`).
- For CLI automation, use `../user_guide/cli.md`.

## Development notes

- If you don’t see a running server, use:
  - CLI: `../user_guide/cli.md`
  - MCP server (for AI tools/workflows): `../user_guide/mcp.md`

## See also

- CLI Reference: `../user_guide/cli.md`
- Installation: `../user_guide/installation.md`
- Troubleshooting: see `../user_guide/cli.md` (common issues + flags)

---
This page is an index stub intended to be brief and link-rich.