Schémas d'outils WebMCP

VérifiéSûr

Concevoir des schémas JSON pour les entrées et sorties des outils WebMCP — types appropriés, contraintes, objets imbriqués et documentation adaptée aux agents. À utiliser lors de la définition ou de l'affinement des schémas d'outils.

Spar Skills Guide Bot
DeveloppementIntermédiaire
24/07/2026
Claude CodeCursorWindsurf
#json-schema#webmcp#tool-definitions#agent-interfaces#validation

Recommandé pour

Synthèse automatique

Ce skill guide la conception de schémas JSON décrivant les entrées et sorties des outils WebMCP afin qu'ils soient exploitables par un agent.

Points forts

  • Couvre le rôle double du schéma : guidage de l'agent et validation côté navigateur
  • Fournit des tableaux de correspondance type/usage et des motifs prêts à l'emploi pour le commerce en ligne (recherche produit, panier, adresse)
  • Insiste sur les annotations `description`, les contraintes (enum, pattern, minimum/maximum) et un jeu de paramètres requis minimal
  • Donne des conventions de sortie concrètes : champ de statut, données structurées, pagination, objets d'erreur

Limites

  • Le fichier s'interrompt au milieu du principe « Minimal surface », la fin des règles de conception manque
  • WebMCP ne spécifie pas formellement de schéma de sortie : les conventions proposées sont des recommandations, pas une norme
  • Le skill impose de récupérer la documentation en ligne avant d'écrire du code, ce qui ajoute des étapes et suppose un accès réseau
Quand l'utiliser

Utilisez-le lorsqu'il faut rédiger ou durcir un `inputSchema` pour un outil WebMCP destiné à être appelé par un agent.

Quand l'éviter

Ne l'utilisez pas pour concevoir des schémas dans un autre cadre (OpenAPI classique, function calling d'un LLM propriétaire) sans vérifier les différences de spécification.

Analyse de sécurité

Sûr
Score qualité86/100

This is a documentation/guidance skill about designing JSON Schemas for WebMCP tools. It contains no executable payloads, no destructive commands, no network calls that pipe into shell, and no credential handling. The declared tools (Bash, WebFetch, WebSearch) are justified for fetching specs and running local work, and all examples are benign schema definitions. It even explicitly advises against collecting sensitive data such as passwords or full card numbers.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Product search schema
Design a WebMCP inputSchema for a tool that searches a product catalog, with a required search query and optional category, max price, and sort order filters.
Tighten an existing schema
Here is my add-to-cart inputSchema — review it and add missing descriptions, constraints, and defaults so an agent can fill it in correctly.
Address validation rules
Add enum and pattern constraints to my shipping address inputSchema so zip codes and countries are validated before the tool executes.

name: webmcp-tool-schemas description: Design JSON Schemas for WebMCP tool inputs and outputs — proper types, constraints, nested objects, and agent-friendly documentation. Use when defining or refining tool schemas for agent consumption. allowed-tools: Read, Write, Edit, Bash, Grep, Glob, WebSearch, WebFetch

WebMCP Tool Schema Design

Before writing code

Fetch live docs:

  1. Fetch https://webmachinelearning.github.io/webmcp/ for the inputSchema specification and any constraints
  2. Web-search webmcp inputSchema JSON Schema requirements for schema format details
  3. Web-search JSON Schema draft specification for the JSON Schema version used by WebMCP
  4. Web-search webmcp tool schema best practices for community guidance

Conceptual Architecture

Role of Schemas in WebMCP

The inputSchema in a tool definition serves two purposes:

  1. Agent guidance — The agent reads the schema to understand what parameters to provide
  2. Input validation — The browser validates agent-provided input against the schema before calling execute

Schema Structure

WebMCP uses standard JSON Schema. Each tool's inputSchema is a JSON Schema object:

inputSchema: {
  type: "object",
  properties: {
    paramName: { type: "string", description: "What this parameter is" },
    // ...more properties
  },
  required: ["paramName"]
}

Property Types

| JSON Schema Type | Use For | Example | |-----------------|---------|---------| | string | Text, IDs, codes | Product ID, search query, coupon code | | number | Decimal values | Price, weight, rating | | integer | Whole numbers | Quantity, page number | | boolean | True/false flags | In-stock filter, gift wrap option | | array | Lists | Product IDs, selected categories | | object | Nested structures | Address, payment details |

Description Annotations

Always add description to properties — agents use these to decide what values to provide:

properties: {
  query: {
    type: "string",
    description: "Search keywords for product catalog"
  },
  maxPrice: {
    type: "number",
    description: "Maximum price in USD. Omit to search all prices."
  }
}

Constraints

Use JSON Schema constraints to guide agent input:

  • minLength / maxLength for strings
  • minimum / maximum for numbers
  • enum for fixed value sets
  • pattern for regex validation
  • minItems / maxItems for arrays
  • default for optional parameters with defaults

Commerce Schema Patterns

Product search:

{
  type: "object",
  properties: {
    query: { type: "string", description: "Search keywords" },
    category: { type: "string", enum: ["electronics", "clothing", "home"] },
    maxPrice: { type: "number", minimum: 0 },
    sortBy: { type: "string", enum: ["relevance", "price_asc", "price_desc", "rating"] }
  },
  required: ["query"]
}

Add to cart:

{
  type: "object",
  properties: {
    productId: { type: "string", description: "Product identifier" },
    quantity: { type: "integer", minimum: 1, maximum: 99, default: 1 },
    variant: { type: "string", description: "Size, color, or variant ID" }
  },
  required: ["productId"]
}

Shipping address:

{
  type: "object",
  properties: {
    street: { type: "string" },
    city: { type: "string" },
    state: { type: "string" },
    zipCode: { type: "string", pattern: "^[0-9]{5}(-[0-9]{4})?$" },
    country: { type: "string", enum: ["US", "CA", "UK"] }
  },
  required: ["street", "city", "state", "zipCode", "country"]
}

Output Conventions

While WebMCP doesn't formally specify an output schema, tools should return predictable JSON:

  • Always include a status or success field
  • Return structured data, not HTML or plain text
  • Include pagination info for list results (total, page, pageSize)
  • Return error objects with code and message for failures

Schema Design Principles

  1. Minimal surface — Only require parameters the tool actually needs
  2. Descriptive — Every property should have a description
  3. Constrained — Use enum, minimum, maximum to prevent invalid inputs
  4. Flat when possible — Avoid deep nesting; agents handle flat schemas better
  5. Consistent — Use the same naming conventions across all tools (camelCase)
  6. No sensitive data — Never ask for passwords, SSNs, or full card numbers in schemas

Fetch the WebMCP spec for the exact JSON Schema version supported and any WebMCP-specific constraints before designing schemas.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/webmcp-tool-schema-design-mryiqgkg' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/webmcp-tool-schema-design-mryiqgkg/download' --output '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md.part' && mv '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md.part' '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Bash, Grep, Glob, WebSearch, WebFetch

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md' && test -s '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/webmcp-tool-schemas' && cp -R '.skill-downloads/webmcp-tool-schema-design-mryiqgkg' '.claude/skills/webmcp-tool-schemas'

Cursor
test -f '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md' && test -s '.skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/webmcp-tool-schemas' && cp -R '.skill-downloads/webmcp-tool-schema-design-mryiqgkg' '.cursor/skills/webmcp-tool-schemas'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/webmcp-tool-schema-design-mryiqgkg'

openskills read 'webmcp-tool-schema-design-mryiqgkg'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/webmcp-tool-schema-design-mryiqgkg/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires