get_ctlsurf_instructions
Initialize a project with ctlsurf or get ctlsurf integration instructions.
Use this when the user says "initialize project with ctlsurf" or "set up ctlsurf for this project".
Returns instructions to add to your project memory/config file (CLAUDE.md, AGENTS.md, .cursorrules, etc.):
ctlsurf as source of truth
Checking pending tasks on session start
Documenting assumptions, shortcuts, decisions
Task workflow (claim, progress, complete, follow-up)
Block types guide (text, checklist, table, tree, react_flow, ctlsurf_task, datastore, state, log)
When to update documentation
Usage:
Detect the git remote URL: run
git remote get-url originDetect the hostname: run
hostnameCall this tool with root_path, repo_url, and hostname
Add the returned 'instructions' to your project memory/config file
Examples:
get_ctlsurf_instructions(root_path="/path/to/project", repo_url="https://github.com/user/repo", hostname="macbook-pro")
get_ctlsurf_instructions(root_path="/path/to/project", format="text")
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Output format: 'markdown' for CLAUDE.md/Copilot, 'text' for .cursorrules/.windsurfrules (default: markdown) | |
| hostname | No | Machine hostname. Auto-detected by the agent via `hostname` or `uname -n` command. Used to track which computer a project lives on. | |
| repo_url | No | Git repository URL (preferred). Detect with: git remote get-url origin | |
| root_path | Yes | Project root path |