Ref MCP

Qu'est-ce que Ref MCP ?

Ref MCP est un serveur MCP spécialisé qui connecte les agents de codage et les outils de développement à un univers de documentation technique soigneusement sélectionnée. Il permet aux agents de rechercher, récupérer et analyser les parties les plus pertinentes de la documentation à la demande, minimisant l'utilisation des tokens et améliorant les performances des LLM lors de l'utilisation des API et des bibliothèques.

Comment configurer Ref MCP

Il existe deux principales méthodes pour configurer Ref MCP en tant que serveur MCP :

1. HTTP Streamable (Recommandé) :

• Installez Ref MCP via des clients compatibles (comme Cursor) en utilisant les liens d'installation fournis ou en spécifiant directement la configuration du serveur :

  "Ref": {
    "type": "http",
    "url": "https://api.ref.tools/mcp?apiKey=YOUR_API_KEY"
  }
  

• Vous devez vous inscrire sur ref.tools pour obtenir une clé API.

2. Serveur stdio Local (Héritage) :

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp@latest"],
  "env": {
    "REF_API_KEY": <your_api_key>
  }
}

• Nécessite Node.js et npm.

En option, pour le développement local et le débogage, vous pouvez cloner le dépôt Ref MCP, installer les dépendances avec npm install, puis exécuter avec npm run dev.

Comment utiliser Ref MCP

1. Connectez votre agent ou outil compatible MCP au serveur Ref MCP à l'aide de la configuration décrite ci-dessus.
2. Utilisez les outils disponibles, comme ref_search_documentation pour rechercher des docs API, ou ref_read_url pour récupérer et distiller le contenu pertinent de la documentation.
3. Les agents peuvent effectuer des recherches et des lectures iteratives, réduisant intelligemment le contexte à ce qui est nécessaire pour la génération ou la compréhension du code.
4. Pour les intégrations OpenAI, Ref MCP adapte automatiquement ses outils aux noms de fonction compatibles avec OpenAI.

Pour le développement et l'inspection, utilisez le MCP Inspector pour tester visuellement et surveiller les interactions.

Fonctionnalités Clés

• Récupération de documentation économe en tokens : Retourne uniquement les sections les plus pertinentes en contexte, évitant les coûts excessifs en tokens et la dégradation des performances.
• Recherche itérative et adaptée aux agents : Adapte les résultats de recherche au cours d'une session, sans jamais répéter les résultats pour des requêtes similaires.
• Enrichissement de contexte à la demande : Permet aux LLM de récupérer la documentation au moment et à l'endroit nécessaires.
• Prend en charge les sources publiques et privées : Recherchez dans les docs publiques, les pages web, GitHub et des ressources privées comme des dépôts internes ou des PDF.
• Gestion de session intégrée : Suit la trajectoire de recherche et de lecture dans une session d'agent pour une meilleure curation de contexte.
• Compatibilité OpenAI : Adapte automatiquement le nom des outils pour une utilisation fluide avec les agents de recherche et de codage d'OpenAI.

Cas d'Utilisation

• Assistants de code alimentés par l'IA : Augmentez les agents de codage (comme Claude Desktop ou Cursor) avec un accès précis à la documentation technique.
• Intégration API automatisée : Aidez les agents à comprendre, mettre en œuvre et résoudre les problèmes des points de terminaison API en fournissant la documentation la plus pertinente.
• Bots de révision et d'audit de code : Équipez les agents avec la capacité de récupérer et de citer des docs autoritaires lors de la révision de code.
• Outils d'intégration des développeurs : Répondez dynamiquement aux questions courantes des développeurs en recherchant et en extrayant des informations des docs d'entreprise ou publiques.
• Recherche technique approfondie : Interrogez efficacement plusieurs sources et concentrez-vous sur le plus petit ensemble de contexte possible pour des réponses précises.

FAQ

Q1: Pourquoi est-il important de minimiser les tokens dans le contexte de la documentation ?
A1: Les LLM tendent à moins bien performer avec de grandes fenêtres de contexte bruyantes, et les tokens coûtent de l'argent. En tirant uniquement les parties pertinentes de la documentation, Ref MCP améliore les performances des LLM et réduit les dépenses API inutiles.

Q2: Quel type de documentation Ref MCP peut-il rechercher ?
A2: Ref MCP recherche une large gamme de documentation publique (APIs, bibliothèques, documents web) et peut également indexer des ressources privées/internes, y compris des dépôts GitHub et des PDF.

Q3: Comment Ref MCP s'assure-t-il que les agents LLM évitent de lire le même contenu à plusieurs reprises ?
A3: Au cours d'une session active, Ref MCP suit les recherches précédentes et les résultats renvoyés, garantissant que chaque recherche similaire produit de nouveaux documents sans duplication, favorisant un ingénierie des requêtes efficace.

Q4: Puis-je utiliser Ref MCP avec mon propre agent ou outil ?
A4: Oui, tout agent ou application prenant en charge le protocole MCP peut se connecter à Ref MCP en utilisant les modes HTTP ou stdio.

Q5: Quelle est la différence entre ref_search_documentation et ref_read_url ?
A5: ref_search_documentation trouve des liens de documentation pertinents et le contexte par requête ; ref_read_url récupère et transforme la page cible en un résumé markdown pour un traitement facile par l'agent.