cortex-contributing
Skill15 starsChanged 5 months agoApache-2.0View on GitHub
Contributing to Cortex — tests, adding MCP tools, conventions, AGENTS.md and skills maintenance. Use when extending the codebase or opening a PR.
- Installs packages
In this repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- cortex-apiSkill
- cortex-authSkill
- cortex-compilerSkill
- cortex-deploySkill
- cortex-feedbackSkill
- cortex-graph-searchSkill
- cortex-mcpSkill
- cortexSkill
- cortex-vaultSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 1 is distinctive, and 3 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.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 36
Add REST route in cortex/api/routes.py if mirrored
- Very specific: line 38
Update .cursor/skills/cortex-mcp/reference.md and README MCP table
- Very specific: line 56
Do not install project skills under ~/.cursor/skills-cursor/ (reserved for Cursor built-ins).
- Distinctive: line 60
Follow project hooks if configured.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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.
Files
Contributing to Cortex
Development setup
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytestExample vault: example_vault/ (or set VAULT_PATH).
Test layout
| Area | Path |
| API | tests/test_api.py |
| MCP | tests/test_mcp.py |
| Feedback | tests/test_feedback.py |
| Teams | tests/test_teams_notify.py |
| Graph | tests/test_graph*.py |
Run focused: pytest tests/test_feedback.py -v
Adding an MCP tool
- Implement handler in
cortex/mcp/tools.py - Register in
cortex/mcp/http_server.pyandcortex/mcp/server.py - Add REST route in
cortex/api/routes.pyif mirrored - Tests in
tests/test_mcp.py(+test_api.pyif REST) - Update
.cursor/skills/cortex-mcp/reference.mdand README MCP table - Mention in
AGENTS.mdskill index if user-facing
Code conventions
- Match existing logging:
logger = logging.getLogger(__name__) - Config via
get_settings()fromcortex/config.py - Vault paths always relative to vault root
- Minimize scope; no drive-by refactors
Agent documentation
| File | Purpose |
AGENTS.md | Always-on repo map for agents |
.cursor/skills/cortex/SKILL.md | Master router skill |
.cursor/skills/cortex-*/SKILL.md | Topic skills |
Do not install project skills under ~/.cursor/skills-cursor/ (reserved for Cursor built-ins).
Pre-commit / CI
Follow project hooks if configured. Fix test failures before claiming done.
Related skills
- Master index:
cortex - Full spec:
docs/superpowers/specs/2026-05-29-cursor-skills-design.md
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
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.

