pg-aiguide

pg-aiguide

Expertise PostgreSQL optimisée pour l'IA, destinée aux assistants de codage

pg-aiguide aide les outils de codage IA à écrire du code PostgreSQL nettement meilleur. Il fournit :

• Recherche sémantique dans le manuel officiel PostgreSQL (conscient de la version)
• « Compétences » optimisées pour l'IA — bonnes pratiques Postgres organisées et pragmatiques, utilisées automatiquement par les agents IA
• Documentation de l'écosystème d'extensions, en commençant par TimescaleDB, avec d'autres à venir

Utilisez-le comme :

• Compétences d'agent via npx skills — fonctionne avec Claude Code, Cursor, Codex, Gemini CLI et plus de 40 autres agents
• un serveur MCP public utilisable avec n'importe quel agent de codage IA, ou
• un plugin Claude Code optimisé pour une utilisation avec le support natif des compétences de Claude.

⭐ Pourquoi pg-aiguide ?

Les outils de codage IA génèrent souvent du code Postgres qui est :

• obsolète
• dépourvu de contraintes et d'index
• ignorant des fonctionnalités modernes de PG
• incohérent avec les bonnes pratiques du monde réel

pg-aiguide corrige cela en donnant aux agents IA une connaissance approfondie et versionnée de PostgreSQL ainsi que des modèles éprouvés.

Voyez la différence

https://github.com/user-attachments/assets/5a426381-09b5-4635-9050-f55422253a3d

🚀 Démarrage rapide

Compétences d'agent

Installez des compétences PostgreSQL organisées selon les bonnes pratiques pour votre agent de codage IA :

npx skills add timescale/pg-aiguide --skill postgres

Ou installez la compétence d'exploration de schéma pour examiner une base de données PostgreSQL existante :

npx skills add timescale/pg-aiguide --skill schema-exploration

Ou choisissez individuellement des compétences de manière interactive :

npx skills add timescale/pg-aiguide

Fonctionne avec Claude Code, Cursor, Codex, Gemini CLI, VS Code et plus de 40 autres agents.

Pour une connaissance encore plus approfondie de PostgreSQL, ajoutez également le serveur MCP pour donner à votre agent une recherche sémantique dans les manuels officiels PostgreSQL, TimescaleDB et PostGIS.

Serveur MCP

Pour une recherche sémantique dans la documentation PostgreSQL, TimescaleDB et PostGIS, ajoutez le serveur MCP public :

https://mcp.tigerdata.com/docs

{
  "mcpServers": {
    "pg-aiguide": {
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

Ou il peut être utilisé comme plugin Claude Code :

claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide

Installation par environnement

claude plugin marketplace add timescale/pg-aiguide
claude plugin install pg@aiguide

codex mcp add --url "https://mcp.tigerdata.com/docs" pg-aiguide

{
  "mcpServers": {
    "pg-aiguide": {
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

gemini mcp add -s user pg-aiguide "https://mcp.tigerdata.com/docs" -t http

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "pg-aiguide": {
      "type": "remote",
      "url": "https://mcp.tigerdata.com/docs"
    }
  }
}

code --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'

code-insiders --add-mcp '{"name":"pg-aiguide","type":"http","url":"https://mcp.tigerdata.com/docs"}'

{
  "mcpServers": {
    "pg-aiguide": {
      "serverUrl": "https://mcp.tigerdata.com/docs"
    }
  }
}

💡 Votre première invite

Une fois installé, pg-aiguide peut répondre à des questions sur Postgres ou concevoir des schémas.

Exemple d'invite simple pour un schéma

Créez un schéma de table Postgres pour stocker des noms d'utilisateur et des adresses e-mail uniques.

Exemple d'invite complexe pour un schéma

Vous êtes un ingénieur logiciel senior. Vous avez pour tâche de générer un schéma Postgres pour une entreprise de dispositifs IoT. Les dispositifs collectent des données environnementales sur un sol d'usine. Les données incluent la température, l'humidité, la pression, comme principaux points de données ainsi que d'autres mesures qui varient d'un dispositif à l'autre. Chaque dispositif a un identifiant unique et un nom lisible par l'humain. Nous voulons également enregistrer l'heure à laquelle les données ont été collectées. L'analyse des données récentes comprend la recherche de valeurs aberrantes et d'anomalies basées sur les mesures, ainsi que l'analyse des données de dispositifs particuliers pour une analyse ad hoc. L'analyse des données historiques comprend l'analyse de l'historique des données pour un dispositif ou l'obtention de statistiques pour tous les dispositifs sur de longues périodes.

Fonctionnalités

Recherche documentaire (outils MCP)

• search_docs Outil de recherche unifié prenant en charge la recherche sémantique (similarité vectorielle) et par mots-clés (BM25) sur plusieurs sources documentaires :
  • postgres - Manuel officiel PostgreSQL, limité par version
  • tiger - Documentation de Tiger Data (TimescaleDB et écosystème)
  • postgis - Documentation de l'extension spatiale PostGIS

Compétences (bonnes pratiques optimisées pour l'IA)

• view_skill
  Expose des compétences PostgreSQL organisées et pragmatiques, utilisées automatiquement par les assistants de codage IA.

  Ces compétences fournissent des conseils sur :

  • L'exploration des schémas et objets PostgreSQL existants
  • La conception de schémas
  • Les stratégies d'indexation
  • Les types de données
  • L'intégrité des données et les contraintes
  • Les conventions de nommage
  • L'optimisation des performances
  • Les fonctionnalités modernes de PostgreSQL

🔌 Documentation de l'écosystème

Pris en charge aujourd'hui :

• TimescaleDB (documentation + compétences)
• PostGIS (documentation)

À venir :

• pgvector

Nous accueillons favorablement les contributions pour des extensions et outils supplémentaires.

🛠 Développement

Voir DEVELOPMENT.md pour :

• exécuter le serveur MCP localement
• ajouter de nouvelles compétences
• ajouter de nouvelles documentations

🤝 Contribution

Nous accueillons favorablement :

• de nouvelles compétences de bonnes pratiques Postgres
• des corpus documentaires supplémentaires
• des améliorations de la qualité de recherche
• des rapports de bogues et des idées de fonctionnalités

📄 Licence

Apache 2.0