mcp-vosdroits: Instructions file for GitHub Copilot

Documentation Standards

Code Documentation

General Principles

• Prioritize self-documenting code through clear naming
• Document all exported symbols (types, functions, methods, constants)
• Start documentation with the symbol name
• Write documentation in English
• Write complete sentences

Package Documentation

• Add package comment at the top of one file in the package
• Start with "Package [name]"
• Explain the package's purpose and main functionality
• Include usage examples when helpful

Example:

// Package tools provides MCP tool implementations for searching
// French public service information from service-public.gouv.fr.
package tools

Function Documentation

• Document what the function does, not how it does it
• Include parameter descriptions when not obvious
• Document return values, especially errors
• Mention any side effects or special behavior

Example:

// SearchProcedures searches for procedures on service-public.gouv.fr
// matching the given query. It returns up to limit results.
// Returns an error if the HTTP request fails or the response is invalid.
func SearchProcedures(ctx context.Context, query string, limit int) ([]Result, error)

Type Documentation

• Document the purpose of the type
• Explain important fields if not obvious
• Document JSON/JSONSCHEMA tags meaning when complex

Constant Documentation

• Document groups of related constants
• Explain the purpose and valid values

README Documentation

Required Sections

1. Project Title and Description

   • Clear, concise description of what the project does

2. Installation

   • How to install/build the project
   • Prerequisites and dependencies

3. Usage

   • Quick start guide
   • Basic examples
   • Common use cases

4. Configuration

   • Environment variables
   • Configuration file format
   • Default values

5. API/Tool Documentation

   • List of available MCP tools
   • Input/output schemas
   • Example requests/responses