Windsurf Setup¶
Set up Windsurf to generate idiomatic adk-fluent and Google ADK code.
1. Project rules — .windsurfrules¶
Windsurf reads a .windsurfrules file from your project root.
If you cloned the repo¶
The file is already generated at .windsurfrules in the project root. Nothing to do.
This file is auto-generated by scripts/llms_generator.py from the ADK manifest. It updates automatically when the API changes via just docs or CI. Do not edit it manually.
If you installed via pip¶
Download the rules file into your project:
curl -L https://raw.githubusercontent.com/vamsiramakrishnan/adk-fluent/master/.windsurfrules \
-o .windsurfrules
Quick use — llms.txt¶
You can also reference the hosted llms.txt directly in Windsurf’s chat:
@web https://vamsiramakrishnan.github.io/adk-fluent/llms.txt
2. MCP server — live documentation access¶
Windsurf supports MCP servers for live documentation access. Open Settings and navigate to the MCP configuration.
adk-fluent GitMCP (free)¶
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"adk-fluent": {
"serverUrl": "https://gitmcp.io/vamsiramakrishnan/adk-fluent"
}
}
}
No authentication required. Windsurf will automatically have access to all adk-fluent documentation.
3. Verify the setup¶
After adding the rules file and MCP server, test it with a prompt like:
Create an adk-fluent agent that classifies customer support tickets
into categories, then routes them to specialized handler agents.
Use a FanOut for parallel processing and write results to state.
Windsurf should:
Import from
adk_fluent(not internal modules)Use the fluent builder pattern with method chaining
Call
.build()to produce native ADK objectsUse
.writes()for state management