ElasticKnown publisherelastic/docs-utils/CLAUDE.md

docs-utils

CLAUDE.md8 starsChanged 4 months agoApache-2.0View on GitHub

This repository builds elastic-docs-utils, a cross-harness installer for Elastic documentation skills and MCP configuration. Do not overwrite an existing MCP configuration or skill directory unless this project previously recorded ownership. Update checks must remain cache-only in host lifecycle hooks; network refreshes are explicit user commands.

The file

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

1 rule. About 0 are common, 1 is distinctive, and 0 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.
0
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Do not overwrite an existing MCP configuration or skill directory unless this project previously recorded ownership.
line 24

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.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

CLAUDE.md

Elastic Docs Utils contributor guide

This repository builds elastic-docs-utils, a cross-harness installer for Elastic documentation skills and MCP configuration.

Layout

cmd/elastic-docs-utils/  CLI entry point
internal/adapters/       Host-specific MCP and lifecycle integrations
internal/skills/         Shared skill catalog installation and safe links
internal/updates/        Cached, explicit update checks
internal/state/          Owned-artifact and preference persistence

Development

GOCACHE=/tmp/docs-utils-go-build go test ./...
GOCACHE=/tmp/docs-utils-go-build go run ./cmd/elastic-docs-utils doctor
GOCACHE=/tmp/docs-utils-go-build go run ./cmd/elastic-docs-utils sync --dry-run

Do not overwrite an existing MCP configuration or skill directory unless this project previously recorded ownership. Update checks must remain cache-only in host lifecycle hooks; network refreshes are explicit user commands.

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