Contributing to brief-desk

Thanks for helping. Keep changes small and testable.

Setup

cd brief-desk
cp .env.example .env.local
# Set OPENAI_API_KEY (Groq) and optional GITHUB_TOKEN
npm install
cd backend && uv sync && cd ..
npm run dev

Path	Role
`app/`	Next.js UI (chat, controls, theme)
`lib/`	brief-run pipeline, MCP client, prompts
`backend/`	Python MCP Streamable HTTP server
`backend/src/brief_desk_mcp/discover.py`	Trending, repo search, releases, security
`mcp/corpus/`	Bundled sample docs
`prompts/`	System / route prompt files

New MCP tools go in backend/, get registered in server.py TOOLS, and should show up on /health.

npm test
npm run typecheck

Python-only: npm run test:mcp:py

Prefer the deterministic /api/brief-run path for panel demos. Free-form chat uses CopilotKit + MCP tools.
Do not add a separate workspace/corpus package. Corpus lives in mcp/corpus/.
Match existing TypeScript and Python style. Skip drive-by refactors.
English commit messages and PR descriptions.

Vercel: Next.js app. Set MCP_URL to the Render MCP endpoint (…/mcp).
Render: use the root Dockerfile so /health reports "runtime":"python" and the current package version.

MIT. By contributing you agree your changes are under the same license.