Skip to content
vibespell

.github/copilot-instructions.md

Copilot instructions for LangChain

GitHub Copilot reads `.github/copilot-instructions.md` and applies it across the repository. It is the place for build commands, review rules, and stack conventions Copilot should not invent. This copy is written for a LangChain project. This repository builds LLM agents or chains. Model names and prompts are explicit. Tool calls validate their arguments. API keys stay in the environment.

The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.

The example assumes a Python agent stack such as LangChain or a similar orchestrator already in the repo. It does not assume LangGraph versus a simple chain, or a hosted tracer. Use what the project already imports.

Example file

Balanced strictness, readable style, pragmatic tests. Download name: copilot-instructions.md

# GitHub Copilot instructions

These instructions apply to the whole LangChain repository. Copilot reads them from `.github/copilot-instructions.md`.
Prefer the commands and layout below over guesses.

## Stack

This repository builds LLM agents or chains. Model names and prompts are explicit. Tool calls validate their arguments. API keys stay in the environment.

## Layout

- Prompts and chain construction live in a module, not only in a notebook.
- Tools are small functions with a schema. They do not import the whole agent.
- Evals live next to the chain they score.

## Commands

- Tests: `pytest`
- Lint: `ruff check .`
- Eval: `Run the project's eval script if it has one`

Use the script the repo already defines when it differs from the command above.

## Conventions

- Name the model in code or config. Do not rely on an implicit default that can change under you.
- Validate tool arguments with the schema before side effects.
- Bound retries and timeouts on model and tool calls.
- Keep prompts in one place so a change is reviewable.
- Add or update an eval when you change a prompt that affects behavior.
- Secrets come from the environment. They are not default arguments.

## Testing

Add or update tests when behavior changes.

Test the tool with a fake model or a direct function call. Assert the side effect did not run on invalid input.

## Style

- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.

## Errors

- Fail at the boundary. Do not swallow errors.
- Return a structured tool error the model can read. Unexpected exceptions should fail the call, not invent an answer.

## Scope

- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.

## Avoid

- Do not give a tool unrestricted shell or filesystem access.
- Do not log full prompts when they may contain user secrets.
- Do not catch a tool error and return a success string.
- Do not add a second orchestration library beside the one the repo uses.

## Done when

- The requested behavior works.
- `pytest` passes, including a test that a bad tool argument does not reach the side effect.
- The diff stays inside the task.
- You list anything you could not run.

## Review checklist

- The change matches the commands and layout in this file.
- No new dependency was added without a reason already present in the repo.
- API keys stay in the environment.
- Tools enforce an allowlist of paths, URLs, or commands.
- Do not send secrets or raw personal data to the model provider.

Add it to the project

  1. 01

    Copy a starting file

    Copy the example Copilot instructions on this page, or open the generator if you want different testing, strictness, or comment rules.

  2. 02

    Save it at .github/copilot-instructions.md

    Save it as `.github/copilot-instructions.md` in the LangChain repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

  3. 03

    Start a fresh agent session

    Rules files are read when a session starts. A chat that is already open may still be using the old instructions.

  4. 04

    Give it one small task

    Ask for one change a LangChain agent often gets wrong, such as a tool whose arguments are validated before it touches the filesystem or the network. If it ignores the file, confirm the path and start a new session.

Questions about this file

Where do I put Copilot instructions in a LangChain repo?

Save it as `.github/copilot-instructions.md` in the LangChain repo. Create the `.github` folder if it is missing. Commit the file so Copilot sees it for every collaborator.

Which tools read this Copilot instructions?

GitHub Copilot in VS Code, Visual Studio, and Copilot cloud agents read this file. Other agents will not load it automatically, so keep an AGENTS.md too if more than one tool edits the repo.

What does the LangChain example assume?

The example assumes a Python agent stack such as LangChain or a similar orchestrator already in the repo. It does not assume LangGraph versus a simple chain, or a hosted tracer. Use what the project already imports.

Does VibeSpell upload my repository?

No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.

Other files for LangChain

Copilot instructions for other stacks