Skip to main content
Glama

generate_copilot_config

Generate GitHub Copilot configuration files to customize AI coding assistance for specific projects, languages, and frameworks.

Instructions

Generates a .github/copilot-instructions.md for GitHub Copilot.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectNameYes
languagesYes
frameworksNo

Implementation Reference

  • The handler function that implements the core logic of generating GitHub Copilot configuration file content based on project name, languages, and frameworks.
    export function generateCopilotConfigHandler(args: any) {
        const { projectName, languages, frameworks = [] } = args;
        const content = `# ${projectName} - GitHub Copilot Instructions\n\n## Tech Stack\n- Languages: ${languages.join(", ")}\n${frameworks.length ? `- Frameworks: ${frameworks.join(", ")}` : ""}\n\n## Guidelines\n- Follow ${languages[0]} idioms\n- Write clear, documented code\n- Include type hints where applicable\n- Write comprehensive tests\n`;
        return { content: [{ type: "text", text: content }] };
    }
  • The Zod schema defining the tool's name, description, and input parameters (projectName, languages, optional frameworks).
    export const generateCopilotConfigSchema = {
        name: "generate_copilot_config",
        description: "Generates a .github/copilot-instructions.md for GitHub Copilot.",
        inputSchema: z.object({
            projectName: z.string(),
            languages: z.array(z.string()),
            frameworks: z.array(z.string()).optional()
        })
    };
  • src/server.ts:112-112 (registration)
    Registration of the tool in the HTTP server registry map, linking the schema and handler.
    ["generate_copilot_config", { schema: generateCopilotConfigSchema, handler: generateCopilotConfigHandler }],
  • src/index.ts:101-101 (registration)
    Registration of the tool in the stdio server registry map, linking the schema and handler.
    ["generate_copilot_config", { schema: generateCopilotConfigSchema, handler: generateCopilotConfigHandler }],
  • src/index.ts:30-30 (registration)
    Import statement bringing in the schema and handler from the aiconfigs module for use in registration.
    generateCopilotConfigSchema, generateCopilotConfigHandler
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool generates a file but doesn't describe where the file is created (e.g., locally or in a repo), whether it overwrites existing files, what permissions are needed, or the output format. For a tool that creates files with no annotation coverage, this is a significant gap in transparency.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is appropriately sized and front-loaded, making it easy to understand at a glance. Every part of the sentence earns its place by specifying the action and output.

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

Completeness2/5

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

Given the complexity (a file-generation tool with 3 parameters), lack of annotations, and no output schema, the description is incomplete. It doesn't address key contextual aspects like where the file is saved, how parameters influence the output, or what the tool returns (e.g., success status or file path). This leaves significant gaps for an AI agent to use the tool effectively.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate by explaining parameters. It provides no information about the three parameters (projectName, languages, frameworks) beyond what the schema minimally defines (types and required status). The description doesn't clarify what these parameters control in the generated file or provide examples, leaving their semantics unclear.

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

Purpose4/5

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

The description clearly states the tool's purpose: 'Generates a .github/copilot-instructions.md for GitHub Copilot.' This specifies the verb ('Generates'), resource (the file), and context (GitHub Copilot). However, it doesn't explicitly differentiate from sibling tools like generate_aider_config or generate_claude_config, which serve similar configuration-generation purposes for different AI assistants.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a GitHub repository), exclusions, or comparisons to sibling tools like generate_github_actions (which might handle broader GitHub workflows) or generate_tests (which focuses on test generation). Usage is implied only by the tool name and description.

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/millsydotdev/Code-MCP'

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