Skip to main content
Glama

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:

  1. Detect the git remote URL: run git remote get-url origin

  2. Detect the hostname: run hostname

  3. Call this tool with root_path, repo_url, and hostname

  4. 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

TableJSON Schema
NameRequiredDescriptionDefault
formatNoOutput format: 'markdown' for CLAUDE.md/Copilot, 'text' for .cursorrules/.windsurfrules (default: markdown)
hostnameNoMachine hostname. Auto-detected by the agent via `hostname` or `uname -n` command. Used to track which computer a project lives on.
repo_urlNoGit repository URL (preferred). Detect with: git remote get-url origin
root_pathYesProject root path

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full behavioral burden. It explains that the tool returns instructions to add to a config file, lists the content returned, and gives the required preparation steps. It does not explicitly state that the tool avoids modifying the project, but the return-value framing makes that reasonably clear.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is longer than necessary but well-structured with a summary, trigger, usage steps, and examples. The front-loaded first sentence immediately conveys the tool's purpose, and the bullet list is scannable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description is self-contained: it gives trigger phrases, parameter discovery commands, call examples, and a detailed list of what the returned instructions cover. Even without an output schema, an agent has enough information to invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds value by showing realistic examples and clarifying that root_path, repo_url, and hostname are all expected when calling the tool, even though only root_path is required by the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the tool's purpose: get ctlsurf integration instructions or initialize a project for ctlsurf. It is distinct from all sibling tools, which focus on pages, blocks, folders, and tasks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use the tool with trigger phrases and provides a clear step-by-step usage workflow. It does not mention when not to use it or compare with an alternative, but no sibling tool appears to fill the same role.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources