agentleFS
Sign inStart free
stacklokstacklok/toolhive-studio/AGENTS.md

toolhive-studio

AGENTS.md173 starsChanged 5 months agoApache-2.0View on GitHub

This file provides guidance to AI coding assistants working with this repository. ToolHive Studio is an Electron desktop application for managing MCP (Model Context Protocol) servers. Built with React, TypeScript, Electron, and Vite. Uses pnpm as package manager. Requires Node.js >=24 <25. Husky/lint-staged automatically run lint + format on staged files. Run pnpm run type-check manually before committing. Do not modify or manually edit:

  • Installs packages

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If API type errors appear, run pnpm run generate-client to refresh

    line 28
  2. Distinctive:

    Always run commands from the repository root, not from subdirectories

    line 30
  3. Distinctive:

    Do not modify or manually edit:

    line 34
  4. Distinctive:

    Imports: use aliases for cross-directory imports, not relative paths

    line 45
  5. Very specific:

    Use .override() / .overrideHandler() for test-specific API responses

    line 53
  6. Very specific:

    Use recordRequests() to assert on outgoing API calls

    line 54
  7. Distinctive:

    Keep PRs small and focused

    line 60

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

This file provides guidance to AI coding assistants working with this repository.

Project Overview

ToolHive Studio is an Electron desktop application for managing MCP (Model Context Protocol) servers. Built with React, TypeScript, Electron, and Vite. Uses pnpm as package manager. Requires Node.js >=24 <25.

Essential Commands

pnpm install                    # Install dependencies
pnpm run start                  # Start dev server with hot reload
pnpm run lint                   # Run ESLint
pnpm run type-check             # TypeScript type checking
pnpm run format                 # Format with Prettier
pnpm run test:nonInteractive    # Run unit tests once
pnpm run test:coverage          # Unit tests with coverage
pnpm run e2e                    # End-to-end tests
pnpm run generate-client        # Regenerate API client from OpenAPI spec
pnpm run knip                   # Detect unused code

Husky/lint-staged automatically run lint + format on staged files. Run pnpm run type-check manually before committing.

Common Gotchas

  • Docker daemon must be running before pnpm run start
  • Node.js version must be >=24 <25 — some native modules break on wrong Node version
  • If API type errors appear, run pnpm run generate-client to refresh
  • Tests run through Electron (pnpm run vitest:electron), not plain Node
  • Always run commands from the repository root, not from subdirectories

Boundaries

Do not modify or manually edit:

  • common/api/generated/* — regenerate via pnpm run generate-client
  • renderer/src/route-tree.gen.ts — auto-generated by TanStack Router plugin
  • node_modules/, out/, .vite/ — build artifacts

Code Conventions

  • File names: kebab-case always (e.g., card-mcp-server.tsx)
  • Components: PascalCase, functional with hooks
  • Path aliases: @/* (renderer/src), @common/*, @utils/*, @mocks/*
  • Imports: use aliases for cross-directory imports, not relative paths
  • Exports: named exports preferred over default exports

Testing Patterns

  • Tests in __tests__/ directories colocated with source
  • API mocking via auto-generated MSW fixtures from OpenAPI spec
  • See docs/mocks.md for mocking patterns
  • Use .override() / .overrideHandler() for test-specific API responses
  • Use recordRequests() to assert on outgoing API calls

Commit and PR Guidelines

  • Conventional Commits format required
  • PR titles validated against conventional commit spec by CI
  • Keep PRs small and focused
  • See CONTRIBUTING.md for details

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