Install and add your model key
Desktop app
- Download the app for your platform from the download buttons above and open it.
- Agree to the terms of use and privacy policy. A checkbox lets you choose whether to send anonymous usage data.
- Choose your model provider (OpenAI, Azure OpenAI or Anthropic) and paste your key. CoreStory saves it to
~/.config/corestory/config.toml, readable only by you.
- Pick a Git repository folder. CoreStory indexes it locally and opens the map.
You only see the terms and model steps the first time. After that, the app opens straight to the folder picker.
Command-line tool
Coding agents: follow the step-by-step install instructions at get.corestory.ai/llms.txt.
Download the command-line tool for your platform from the latest release and put corestory on your PATH. Run setup once to accept the terms and add your model key, then index a repository:
corestory --version
corestory setup
cd your-repo
corestory init
corestory ingest
CoreStory keeps its index in a .corestory folder inside the repository. Add .corestory/ to your .gitignore.
Connect your coding agent
Your agent talks to CoreStory through the corestory command-line tool, which serves the repository’s map over MCP. Install the command-line tool and run corestory setup first (see above). CoreStory serves the repository it is started in, so each setup below starts it from your repository folder.
Claude Code
Install the local CoreStory plugin. It connects CoreStory to the repository you open and adds the CoreStory skills. It needs no account and makes no network calls.
claude plugin marketplace add corestoryai/agent-skills
claude plugin install corestory-local@corestory
GitHub Copilot (VS Code and CLI)
Add a .mcp.json file at the root of your repository. Commit it to share the setup with your team. Claude Code reads this file too, if you would rather not use the plugin.
{
"mcpServers": {
"corestory": {
"type": "stdio",
"command": "corestory",
"args": ["mcp"]
}
}
}
Open the repository folder in your agent. Copilot CLI asks you to trust the folder, and Claude Code asks you to approve the server the first time.
Cursor
Add .cursor/mcp.json to your repository. Cursor has no working-directory setting, so this starts CoreStory from the project folder (macOS and Linux):
{
"mcpServers": {
"corestory": {
"type": "stdio",
"command": "sh",
"args": ["-c", "cd \"$0\" && exec corestory mcp", "${workspaceFolder}"]
}
}
}
Codex
Add the server to ~/.codex/config.toml, with cwd set to your repository:
[mcp_servers.corestory]
command = "corestory"
args = ["mcp"]
cwd = "/absolute/path/to/your-repo"
Agent Skills
Teach your agent CoreStory’s workflows with the Agent Skills. For Codex, install them with the GitHub CLI:
gh skill install corestoryai/agent-skills --all --agent codex --scope user
Using hosted CoreStory with your organization? Follow the Agent Skills install guide with your organization’s MCP URL.