Skip to content

AGENTS.md

Latest commit

 

History

History
65 lines (50 loc) · 2.74 KB

AGENTS.md

File metadata and controls

65 lines (50 loc) · 2.74 KB
Raw

AGENTS.md

Multi-level reasoning MCP server with configurable depth levels, published as @j0hanz/cortex-mcp.

Tooling

  • Manager: npm
  • Frameworks: typescript, eslint, @modelcontextprotocol/sdk, @modelcontextprotocol/sdk, @trivago/prettier-plugin-sort-imports, eslint, eslint-config-prettier, eslint-plugin-de-morgan

Commands

  • Dev: npm run dev
  • Test: npm run test
  • Lint: npm run lint
  • Deploy: npm run prepublishOnly

Safety Boundaries

  • Always: npm run lint, npm run type-check, npm run test
  • Ask First: installing dependencies, deleting files, running full builds or e2e suites, database/schema migrations, deploy or infrastructure changes, git push / force push, npm run build, npm run test:coverage, npm run prepublishOnly, git push origin master --follow-tags, gh release create "v$VERSION" --title "v$VERSION" --generate-notes, npm publish --access public --provenance --ignore-scripts
  • Never: Never read or exfiltrate secrets or credentials.; Never edit generated files like .git manually.; commit or expose secrets/credentials; edit vendor/generated directories; change production config without approval

Directory Overview

.
├── .github/            # CI/workflows and repo automation
├── .vscode/
├── assets/             # static assets
├── memory_db/
├── scripts/            # automation scripts
├── src/                # application source
├── .prettierignore     # formatter config
├── .prettierrc         # formatter config
├── docker-compose.yml  # local container orchestration
├── Dockerfile          # container image build
├── eslint.config.mjs   # lint config
├── package.json        # scripts and dependencies
├── README.md           # usage and setup docs
├── server.json         # published server metadata
├── tsconfig.build.json # TypeScript config
└── tsconfig.json       # TypeScript config
└── ...                # 1 more top-level items omitted

Navigation

  • Entry Points: package.json, README.md, src/index.ts, src/server.ts, docker-compose.yml
  • Key Configs: .prettierrc, tsconfig.json

Don'ts

  • Don't bypass existing lint/type rules without approval.
  • Don't ignore test failures in CI.
  • Don't use unapproved third-party packages without checking package manager manifests.
  • Don't hardcode secrets or sensitive info in code, tests, docs, or config.
  • Don't edit generated files directly.
  • Don't trigger releases without approval.

Change Checklist

  1. Run npm run lint to fix lint errors.
  2. Run npm run type-check to verify types.
  3. Run npm run test to ensure tests pass.
  4. Run npm run format to format code.