yams/docs/api/README.md
2026-04-07 13:27:11 -04:00

22 lines
821 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# YAMS API Documentation
A concise index for YAMS programmatic interfaces (MCP tools + plugin interfaces).
## What’s here
- [MCP Tools](mcp_tools.md) — composite tool surface (query, execute, session)
- [Graph Adapter v1](graph_adapter_v1.md) — knowledge graph query interface
- [Storage Plugin v1](storage_plugin_v1.md) — storage backend plugin API
If you’re integrating YAMS today, start with the MCP tools and [CLI reference](../user_guide/cli.md).
## Quick usage patterns
- For AI / tool integrations, use [MCP tools](mcp_tools.md) (see also the [MCP setup guide](../user_guide/mcp.md)).
- For CLI automation, see the [CLI reference](../user_guide/cli.md).
## See also
- [CLI Reference](../user_guide/cli.md)
- [Installation](../user_guide/installation.md)
- [MCP Setup Guide](../user_guide/mcp.md)