mcpField
M
mastra-embeded-docs-look-up

mastra-embeded-docs-look-up

github.com/mastra-aiDevelopment9940 installsUpdated 1d ago
Repository

About mastra-embeded-docs-look-up

mastra-embeded-docs-look-up is a skill for finding API signatures in documentation bundled with installed Mastra packages. It uses version-matched type definitions and topic docs, which is useful when Mastra APIs change frequently.

Key features

  1. 01Searches package export mappings
  2. 02Reads installed type definitions
  3. 03Locates feature topic documentation
  4. 04Covers core, memory, and RAG packages

Use cases

  1. 01Checking an installed Mastra API signature
  2. 02Verifying APIs against the local package version

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/mastra-ai/skills --skill mastra-embeded-docs-look-up

After installing, type/mastra-embeded-docs-look-upin Claude Code to confirm it loaded.

Details

From the project README

Mastra Embedded Docs Lookup

Look up API signatures from embedded docs in node_modules/@mastra/*/dist/docs/ - these match the installed version.

Documentation Structure

node_modules/@mastra/core/dist/docs/
├── SKILL.md           # Package overview, exports
├── SOURCE_MAP.json    # Export→file mappings
└── [topics]/          # Feature docs (agents/, workflows/, etc.)

Lookup Process

1. Find the export:

cat node_modules/@mastra/core/dist/docs/SOURCE_MAP.json | grep '"Agent"'

Returns: { "Agent": { "types": "dist/agent/agent.d.ts", ... } }

2. Read type definition:

cat node_modules/@mastra/core/dist/agent/agent.d.ts

3. Check topic docs:

cat node_modules/@mastra/core/dist/docs/agents/01-overview.md

Common Packages

PackagePathContains
@mastra/corenode_modules/@mastra/core/dist/docs/Agents, Workflows, Tools
@mastra/memorynode_modules/@mastra/memory/dist/docs/Memory systems
@mastra/ragnode_modules/@mastra/rag/dist/docs/RAG features

Quick Commands

# List installed packages
ls node_modules/@mastra/

# Find export in SOURCE_MAP
cat node_modules/@mastra/core/dist/docs/SOURCE_MAP.json | grep '"ExportName"'

# Read type definition
cat node_modules/@mastra/core/dist/[path-from-source-map]

# List available topics
ls node_modules/@mastra/core/dist/docs/

Why Use This

  • Embedded docs match installed version
  • Mastra is in active beta (APIs change frequently)
  • Training data may be outdated
  • Type definitions include JSDoc and examples

Comments

Markdown supported