agentleFS
Sign inStart free
DatabricksKnown publisherdatabricks/sdk-go/AGENTS.md

sdk-go

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

New Go SDK for the Databricks platform. Multi-module workspace with separate Go modules for each service area, plus hand-written authentication and core infrastructure. For scoped coding rules, skills, and prompt templates, see the .agent/ directory. Prerequisites: Go 1.25+ (see go.work). CI runs tests across all modules discovered via go.work, with go test -v -race. Linting uses golangci-lint and formatting is checked via gofmt. This is a Go workspace (go.work) with multiple modules: PR template requires: Changes (what + why) and…

  • 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,774 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 repository3 other files it gives its agents.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Do NOT use context.Background() in production code (only in tests)

    line 55
  2. Distinctive:

    Do NOT add dependencies without checking license compatibility (Apache 2.0 required)

    line 56
  3. Distinctive:

    Do NOT break backwards compatibility of exported APIs without discussion

    line 57
  4. Distinctive:

    Run tests and lint before submitting.

    line 70

≈ “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

Databricks SDK for Go

New Go SDK for the Databricks platform. Multi-module workspace with separate Go modules for each service area, plus hand-written authentication and core infrastructure.

For scoped coding rules, skills, and prompt templates, see the .agent/ directory.

Rules (.agent/rules/)

  • api-design.md — API design principles for the Databricks SDK.
  • error-handling.md — Error handling conventions for the Databricks SDK.
  • style-guide.md — Go code style and naming conventions for the Databricks SDK.
  • testing.md — Testing standards and anti-patterns for the Databricks SDK.

Skills (.agent/skills/)

  • write-pr-description — Write or improve a GitHub pull request description.

Prompts (.agent/prompts/)

  • code-review.md — Review PR or code changes for backward compatibility, correctness, and style.

Development

Prerequisites: Go 1.25+ (see go.work).

go test ./...          # Run tests for the current module
go vet ./...           # Vet the current module
gofmt -l -w .          # Format all Go files
golangci-lint run ./... # Lint the current module

CI runs tests across all modules discovered via go.work, with go test -v -race. Linting uses golangci-lint and formatting is checked via gofmt.

Architecture

This is a Go workspace (go.work) with multiple modules:

├── auth/            # Authentication infrastructure (hand-written)
│   ├── credentials/ # Credential providers (CLI, PAT, etc.)
│   └── ...          # Token types, interfaces
├── core/            # Core utilities shared across modules
├── databricks/      # Databricks client, transport, and API error handling
├── dataquality/     # Data quality APIs
├── iam/             # Identity and access management APIs
├── qualitymonitor/  # Quality monitor APIs
├── sdk/             # High-level SDK entry point
├── settings/        # Settings APIs
└── examples/        # Usage examples

Common Mistakes

  • Do NOT use context.Background() in production code (only in tests)
  • Do NOT add dependencies without checking license compatibility (Apache 2.0 required)
  • Do NOT break backwards compatibility of exported APIs without discussion

Where to Put New Code

  1. New auth method? → auth/credentials/ (implement the appropriate interface)
  2. Auth infrastructure? → auth/
  3. New service API client? → appropriate service module (databricks/, iam/, etc.)
  4. Shared utilities? → core/
  5. Usage examples? → examples/

Pull Requests

PR template requires: Changes (what + why) and Tests sections. Run tests and lint before submitting.

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