agentleFS
Sign inStart free
ElasticKnown publisherelastic/mastra-elasticsearch-example/AGENTS.md

mastra-elasticsearch-example

AGENTS.md5 starsChanged 8 months agoApache-2.0View on GitHub

This document provides guidance for AI coding agents working in this repository. BEFORE doing ANYTHING with Mastra code or answering Mastra questions, load the Mastra skill FIRST. See Mastra Skills section for loading instructions. This is a Mastra project written in TypeScript. Mastra is a framework for building AI-powered applications and agents with a modern TypeScript stack. Use these commands to interact with the project. Start the Mastra Studio at localhost:4111 by running the dev script: In order to build…

  • Reads credentials
  • Installs packages

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. Array-Ventures/coworker★ 41100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use these commands to interact with the project.

    line 17
  2. Very specific:

    Start the Mastra Studio at localhost:4111 by running the dev script:

    line 27
  3. Very specific:

    Load the Mastra skill FIRST: - Use /mastra command or Skill tool

    line 77

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

This document provides guidance for AI coding agents working in this repository.

CRITICAL: Mastra Skill Required

BEFORE doing ANYTHING with Mastra code or answering Mastra questions, load the Mastra skill FIRST.

See Mastra Skills section for loading instructions.

Project Overview

This is a Mastra project written in TypeScript. Mastra is a framework for building AI-powered applications and agents with a modern TypeScript stack.

Commands

Use these commands to interact with the project.

Installation

npm install

Development

Start the Mastra Studio at localhost:4111 by running the dev script:

npm run dev

Build

In order to build a production-ready server, run the build script:

npm run build

Project Structure

Folders organize your agent's resources, like agents, tools, and workflows.

FolderDescription
src/mastraEntry point for all Mastra-related code and configuration.
src/mastra/agentsDefine and configure your agents - their behavior, goals, and tools.
src/mastra/workflowsDefine multi-step workflows that orchestrate agents and tools together.
src/mastra/toolsCreate reusable tools that your agents can call
src/mastra/mcp(Optional) Implement custom MCP servers to share your tools with external agents
src/mastra/scorers(Optional) Define scorers for evaluating agent performance over time
src/mastra/public(Optional) Contents are copied into the .build/output directory during the build process, making them available for serving at runtime

Top-level files

Top-level files define how your Mastra project is configured, built, and connected to its environment.

FileDescription
src/mastra/index.tsCentral entry point where you configure and initialize Mastra.
.env.exampleTemplate for environment variables - copy and rename to .env to add your secret model provider keys.
package.jsonDefines project metadata, dependencies, and available npm scripts.
tsconfig.jsonConfigures TypeScript options such as path aliases, compiler settings, and build output.

Mastra Skills

Skills are modular capabilities that extend agent functionalities. They provide pre-built tools, integrations, and workflows that agents can leverage to accomplish tasks more effectively.

This project has skills installed for the following agents:

  • Claude Code
  • Cursor

Loading Skills

  1. Load the Mastra skill FIRST - Use /mastra command or Skill tool
  2. Never rely on cached knowledge - Mastra APIs change frequently between versions
  3. Always verify against current docs - The skill provides up-to-date documentation

Why this matters: Your training data about Mastra is likely outdated. Constructor signatures, APIs, and patterns change rapidly. Loading the skill ensures you use current, correct APIs.

Skills are automatically available to agents in your project once installed. Agents can access and use these skills without additional configuration.

Resources

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free