Skip to main content
Glama

setup_copilot_instructions

Analyze a repository to generate project-specific copilot instructions and a full tool-reference guide for AI coding assistants.

Instructions

Analyze a repository and generate two files: a lean .github/copilot-instructions.md (project-specific facts only — stack, commands, lxDIG bootstrap) and a .github/lxdig-agent-guide.md (full tool-reference guide with correct signatures, decision table, pitfalls, and usage patterns). The guide is read on demand so it does not saturate the ambient instruction context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetPathNoAbsolute path to the target repository (defaults to the active workspace)
projectNameNoOverride the detected project name
dryRunNoReturn the generated content without writing the file
overwriteNoReplace an existing copilot-instructions.md
profileNoResponse profilecompact
Behavior3/5

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

No annotations provided, so description carries full burden. It explains the files generated and mentions on-demand reading to avoid context saturation, but lacks details on side effects, permissions, or analysis scope.

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?

Description is concise and front-loaded with the main action in two sentences. However, it lacks structure like bullet points or clear separation of file purposes.

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

Completeness4/5

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

Given no output schema and no annotations, the description adequately conveys what the tool creates and the rationale for the guide file. It lacks some behavioral details but is sufficient for a setup tool.

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

Parameters3/5

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

Schema coverage is 100% with each parameter described. Description does not add meaning beyond the schema; baseline of 3 is appropriate.

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 states the tool analyzes a repository and generates two specific files with distinct purposes. It implicitly distinguishes from sibling tools, which are mostly analysis/query tools, by being a setup tool.

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

Usage Guidelines2/5

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

No explicit guidance on when to use this tool vs alternatives, prerequisites, or scenarios for using the parameters. The description only states what the tool does without usage context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lexCoder2/lxDIG-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server