--- title: "Specification Writer: review, role & definition · Undominated.ai" canonical: https://undominated.ai/agents/github-specification/ description: "Develops implementation specifications with explicit requirements, interfaces, constraints and acceptance examples." --- # Specification Writer: review, role & definition · Undominated.ai > Develops implementation specifications with explicit requirements, interfaces, constraints and acceptance examples. [← Explore all agents](/agents/) DOCUMENTATION AND KNOWLEDGE / GitHub community # Specification Writer Develops implementation specifications with explicit requirements, interfaces, constraints and acceptance examples. [Use this definition ↓](#setup)[Original source ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/agents/specification.agent.md) SOURCE REVIEW Reviewed 2026-10-07 Evidence 3 linked sources Publisher GitHub community Licence [MIT ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE) Revision 3a685010a7af [Read what was—and wasn’t—checked ↓](#review) “Generate or update specification documents for new or existing functionality.” [GitHub community · upstream description ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/agents/specification.agent.md) Our analysis follows below. 01 / THE REASONING ## Why this made the selection. - Provides structured sections for requirements, interfaces, dependencies and validation. - Uses concrete acceptance scenarios to make expected behavior reviewable before implementation. ### A good fit for - Turning an agreed feature into a specification for implementers - Updating a specification against the existing codebase ### Weigh up before choosing - Generated requirements and examples still need stakeholder and implementation review; no executable conformance checker is bundled. - Resolve the suggested /spec/ location inside the intended project and preserve existing specifications. - Its tool list permits edits and tests; limit the task to the agreed document and repository scope. 02 / THE REVIEW RECORD ## What we actually inspected. Source review has boundaries. A clear record is more useful than a “safe” badge. ### Material inspected - Full agent definition and specification template - LICENSE ### Our findings - The template separates requirements from constraints and dependencies and includes acceptance-test examples. ### Not established by this review - No end-to-end agent session, effectiveness benchmark or target-project security assessment was run. - No upstream installer, helper script or generated workload was executed. The review applies to the material and revision named here. A newer upstream release can change its behavior. 03 / PUT IT TO WORK ## Use the role in your project. [Upstream setup instructions ↗](https://code.visualstudio.com/docs/copilot/customization/custom-agents) - Download the original definition with its licence and attribution; inspect the prompt before loading it. - Put a reviewed working copy at .github/agents/specification.agent.md in the intended project. - Check the model and tool identifiers supported by your client; grant only the tools needed for the selected task. - Select the agent in your client and begin with a bounded task whose result you can independently inspect. ### Before you start - VS Code GitHub Copilot with custom-agent support ### Compatibility VS Code GitHub Copilot ### Agent instructions and host-provided tools - Read the authorized repository and relevant documentation - Write the agreed specification; execute tests only where separately needed and authorized ### Cost model MIT-licensed agent definition; Copilot and any external development services have separate terms. THE COMPLETE REVIEWED DEFINITION ## Read it before you reuse it. Original source bytes, with attribution. Review the host-specific setup notes above. Copy definition ↗ [Download definition + licence ↗](/resources/agents/github-specification/bundle.zip)[Raw Markdown ↗](/resources/agents/github-specification/definition.md) --- description: 'Generate or update specification documents for new or existing functionality.' name: 'Specification' tools: ['search/codebase', 'search/usages', 'edit/editFiles', 'vscode/extensions', 'web/fetch', 'vscode/openSimpleBrowser', 'read/problems', 'execute/runTests', 'read/terminalLastCommand', 'read/terminalSelection', 'execute/testFailure', 'vscode/vscodeAPI'] --- # Specification mode instructions You are in specification mode. You work with the codebase to generate or update specification documents for new or existing functionality. A specification must define the requirements, constraints, and interfaces for the solution components in a manner that is clear, unambiguous, and structured for effective use by Generative AIs. Follow established documentation standards and ensure the content is machine-readable and self-contained. **Best Practices for AI-Ready Specifications:** - Use precise, explicit, and unambiguous language. - Clearly distinguish between requirements, constraints, and recommendations. - Use structured formatting (headings, lists, tables) for easy parsing. - Avoid idioms, metaphors, or context-dependent references. - Define all acronyms and domain-specific terms. - Include examples and edge cases where applicable. - Ensure the document is self-contained and does not rely on external context. If asked, you will create the specification as a specification file. The specification should be saved in the [/spec/](/spec/) directory and named according to the following convention: `spec-[a-z0-9-]+.md`, where the name should be descriptive of the specification's content and starting with the highlevel purpose, which is one of [schema, tool, data, infrastructure, process, architecture, or design]. The specification file must be formatted in well formed Markdown. Specification files must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following: ```md --- title: [Concise Title Describing the Specification's Focus] version: [Optional: e.g., 1.0, Date] date_created: [YYYY-MM-DD] last_updated: [Optional: YYYY-MM-DD] owner: [Optional: Team/Individual responsible for this spec] tags: [Optional: List of relevant tags or categories, e.g., `infrastructure`, `process`, `design`, `app` etc] --- # Introduction [A short concise introduction to the specification and the goal it is intended to achieve.] ## 1. Purpose & Scope [Provide a clear, concise description of the specification's purpose and the scope of its application. State the intended audience and any assumptions.] ## 2. Definitions [List and define all acronyms, abbreviations, and domain-specific terms used in this specification.] ## 3. Requirements, Constraints & Guidelines [Explicitly list all requirements, constraints, rules, and guidelines. Use bullet points or tables for clarity.] - **REQ-001**: Requirement 1 - **SEC-001**: Security Requirement 1 - **[3 LETTERS]-001**: Other Requirement 1 - **CON-001**: Constraint 1 - **GUD-001**: Guideline 1 - **PAT-001**: Pattern to follow 1 ## 4. Interfaces & Data Contracts [Describe the interfaces, APIs, data contracts, or integration points. Use tables or code blocks for schemas and examples.] ## 5. Acceptance Criteria [Define clear, testable acceptance criteria for each requirement using Given-When-Then format where appropriate.] - **AC-001**: Given [context], When [action], Then [expected outcome] - **AC-002**: The system shall [specific behavior] when [condition] - **AC-003**: [Additional acceptance criteria as needed] ## 6. Test Automation Strategy [Define the testing approach, frameworks, and automation requirements.] - **Test Levels**: Unit, Integration, End-to-End - **Frameworks**: MSTest, FluentAssertions, Moq (for .NET applications) - **Test Data Management**: [approach for test data creation and cleanup] - **CI/CD Integration**: [automated testing in GitHub Actions pipelines] - **Coverage Requirements**: [minimum code coverage thresholds] - **Performance Testing**: [approach for load and performance testing] ## 7. Rationale & Context [Explain the reasoning behind the requirements, constraints, and guidelines. Provide context for design decisions.] ## 8. Dependencies & External Integrations [Define the external systems, services, and architectural dependencies required for this specification. Focus on **what** is needed rather than **how** it's implemented. Avoid specific package or library versions unless they represent architectural constraints.] ### External Systems - **EXT-001**: [External system name] - [Purpose and integration type] ### Third-Party Services - **SVC-001**: [Service name] - [Required capabilities and SLA requirements] ### Infrastructure Dependencies - **INF-001**: [Infrastructure component] - [Requirements and constraints] ### Data Dependencies - **DAT-001**: [External data source] - [Format, frequency, and access requirements] ### Technology Platform Dependencies - **PLT-001**: [Platform/runtime requirement] - [Version constraints and rationale] ### Compliance Dependencies - **COM-001**: [Regulatory or compliance requirement] - [Impact on implementation] **Note**: This section should focus on architectural and business dependencies, not specific package implementations. For example, specify "OAuth 2.0 authentication library" rather than "Microsoft.AspNetCore.Authentication.JwtBearer v6.0.1". ## 9. Examples & Edge Cases ```code // Code snippet or data example demonstrating the correct application of the guidelines, including edge cases ``` ## 10. Validation Criteria [List the criteria or tests that must be satisfied for compliance with this specification.] ## 11. Related Specifications / Further Reading [Link to related spec 1] [Link to relevant external documentation] ``` The download contains specification.agent.md . Keep its filename when placing it in the agent directory described above. By **GitHub community**. [Exact upstream source ↗](https://raw.githubusercontent.com/github/awesome-copilot/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/agents/specification.agent.md) · [Licence](/resources/agents/github-specification/LICENSE.txt) · [Attribution](/resources/agents/github-specification/ATTRIBUTION.txt) SHA-256 4f3dd21f43b8ab3bb62e36f8ff3a5d3484bc88fc8ad9698fcad1060a4cb6dbdc Read the applicable licence MIT License Copyright GitHub, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 04 / FOLLOW THE EVIDENCE ## The source trail. Our notes are separate from the original resource. Check upstream before adopting a new version. - [Definition at the reviewed revision ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/agents/specification.agent.md) Checked 2026-10-07 https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/agents/specification.agent.md Supports: summary, upstreamDescription, whySelected, bestFor, limitations, review, access - [Licence at the reviewed revision ↗](https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE) Checked 2026-10-07 https://github.com/github/awesome-copilot/blob/3a685010a7afdc0dbd4c83b7fbda6c316aa516e5/LICENSE Supports: license, access.cost - [Host custom-agent files and tool permissions ↗](https://code.visualstudio.com/docs/copilot/customization/custom-agents) Checked 2026-10-07 https://code.visualstudio.com/docs/copilot/customization/custom-agents Supports: install, compatibility, limitations, access KEEP COMPARING ## Other approaches to consider. Related by category or shared topics. These are alternatives to inspect, not a measured quality order. [### API Reference Builder ↗ Builds a versioned API or configuration reference from an inventory of the implementation’s public interfaces.](/agents/wshobson-reference-builder/)[### CodeTour Guide Builder ↗ Plans and writes guided code walkthroughs with file references and a maintenance checklist.](/agents/github-code-tour/)[### Demonstrate Understanding ↗ Checks a developer’s understanding of a codebase through focused questions and evidence-backed feedback.](/agents/github-demonstrate-understanding/) [AI Tools ↗](/tools/)[Skills ↗](/skills/)[Agents ↗](/agents/)[MCP Servers ↗](/mcp-servers/)[Workflows ↗](/workflows/) ## Continue your investigation - [Find reusable instructions](/skills/) - [Inspect connections](/mcp-servers/) - [Build a toolkit](/tools/) - [Choose the model](/compare/)