.windsurf/rules/project.md
Windsurf rules for LangChain
Windsurf rules tell the Cascade agent how this repo is built and tested. The current location is `.windsurf/rules`. Older setups still read a root `.windsurfrules` file. 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: project.md. Legacy path: .windsurfrules
# Windsurf rules
Rules for Windsurf Cascade in this LangChain repository.
If the project still uses a root `.windsurfrules` file, keep the same rules there.
## 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.
Add it to the project
01
Copy a starting file
Copy the example Windsurf rules on this page, or open the generator if you want different testing, strictness, or comment rules.
02
Save it at .windsurf/rules/project.md
Save it at `.windsurf/rules/project.md` in the LangChain repo. If the project still uses a single root file, save the same body as `.windsurfrules`.
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.
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 Windsurf rules in a LangChain repo?
Save it at `.windsurf/rules/project.md` in the LangChain repo. If the project still uses a single root file, save the same body as `.windsurfrules`.
Which tools read this Windsurf rules?
Windsurf reads `.windsurf/rules/*.md` and, on older projects, `.windsurfrules`. Cursor and Claude Code do not load this path.
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
Windsurf rules for other stacks
- Windsurf rules for Next.js
- Windsurf rules for React
- Windsurf rules for Vue
- Windsurf rules for SvelteKit
- Windsurf rules for Node.js
- Windsurf rules for FastAPI
- Windsurf rules for Django
- Windsurf rules for Go
- Windsurf rules for Rust
- Windsurf rules for Unity
- Windsurf rules for Godot
- Windsurf rules for Laravel
- Windsurf rules for Rails
- Windsurf rules for Flutter
- Windsurf rules for Swift
- Windsurf rules for Kotlin
- Windsurf rules for Unreal
- Windsurf rules for Next.js + Supabase
- Windsurf rules for T3
- Windsurf rules for Astro
- Windsurf rules for Remix
- Windsurf rules for Nuxt
- Windsurf rules for Electron
- Windsurf rules for Tauri
- Windsurf rules for Expo
- Windsurf rules for Spring Boot
- Windsurf rules for .NET
- Windsurf rules for Phaser
- Windsurf rules for Bevy
- Windsurf rules for Roblox
- Windsurf rules for Python ML