Aller au contenu

Serveur MCP TypeScript

Filter this guidePick generator option values to hide sections that don't apply.

Générer un serveur Model Context Protocol (MCP) TypeScript pour fournir du contexte aux grands modèles de langage (LLM), et éventuellement le déployer sur Amazon Bedrock AgentCore.

Le Model Context Protocol (MCP) est un standard ouvert qui permet aux assistants IA d’interagir avec des outils et des ressources externes. Il fournit une manière cohérente pour les LLM de :

  • Exécuter des outils (fonctions) qui effectuent des actions ou récupèrent des informations
  • Accéder à des ressources qui fournissent du contexte ou des données

Vous pouvez générer un serveur MCP TypeScript de deux manières :

Terminal window
pnpm nx g @aws/nx-plugin:ts#mcp-server
Vous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés
Terminal window
pnpm nx g @aws/nx-plugin:ts#mcp-server --dry-run
ParamètreTypePar défautDescription
project Requisstring-Le projet auquel ajouter un serveur MCP
name string-Le nom de votre serveur MCP (par défaut : mcp-server)
auth iam | cognitoiamLa méthode utilisée pour s'authentifier auprès de votre serveur MCP. Applicable uniquement lorsque infra est défini (ignoré lorsque infra est none).
iac inherit | cdk | terraforminheritLe fournisseur IaC préféré. Par défaut, cette valeur est héritée de votre sélection initiale.
infra agentcore | noneagentcoreLe type d'infrastructure pour héberger votre serveur MCP. Sélectionnez none pour aucun hébergement.
preferInstallDependencies booleantrueIndique s'il faut privilégier l'installation des dépendances après l'exécution du générateur. Définir sur false pour différer l'installation lors de l'exécution de plusieurs générateurs en lot (une installation s'exécute quand même si nécessaire pour que les générateurs suivants puissent calculer le graphe de projet Nx) ; installer une seule fois à la fin.

Le générateur ajoutera les fichiers suivants à votre projet TypeScript existant :

  • Répertoireyour-project/
    • Répertoiresrc/
      • Répertoiremcp-server/ (ou nom personnalisé si spécifié)
        • index.ts Exports your server
        • server.ts Main server definition
        • stdio.ts Entry point for STDIO transport, useful for simple local MCP servers
        • http.ts Entry point for Streamable HTTP transport, useful for hosting your MCP server
        • Répertoiretools/
          • divide.ts Sample tool
        • Répertoireresources/
          • sample-guidance.ts Sample resource
        • Dockerfile Entry point for hosting your MCP server (excluded when infra is set to None)
    • project.json Updated with MCP server serve target
infra = agentcore

Étant donné que ce générateur fournit de l’infrastructure en tant que code basée sur votre iac choisi, il créera un projet dans packages/common qui inclut les constructs CDK ou modules Terraform pertinents.

Le projet d’infrastructure en tant que code commun est structuré comme suit :

  • Répertoirepackages/common/constructs
    • Répertoiresrc
      • Répertoireapp/ Constructs pour l’infrastructure spécifique à un projet/générateur
      • Répertoirecore/ Constructs génériques qui sont réutilisés par les constructs dans app
      • index.ts Entry point exporting constructs from app
    • project.json Project build targets and configuration

Pour déployer votre serveur MCP, les fichiers suivants sont générés :

  • Répertoirepackages/common/constructs/src
    • Répertoireapp
      • Répertoiremcp-servers
        • Répertoire<mcp-server-name>
          • <mcp-server-name>.ts CDK construct for deploying your MCP Server
infra = none

Si vous avez sélectionné none pour infra, aucune construction CDK ou module Terraform n’est généré — le serveur MCP est configuré uniquement pour une utilisation locale STDIO / HTTP. L’option auth est ignorée dans ce mode car il n’y a pas de point de terminaison hébergé à authentifier.

Lorsqu’il est déployé sur Bedrock AgentCore Runtime, le serveur MCP est construit dans une image de conteneur, poussé vers Amazon ECR et exécuté dans AgentCore Runtime. Les assistants IA invoquent le point de terminaison du plan de données AgentCore Runtime, qui transmet les appels tools/* et resources/* à votre serveur via le transport HTTP diffusable.

AI AssistantECRMCP Server(AgentCore Runtime)CloudWatch(Logs, Metrics) StreamableHTTP Containerimage

Les outils sont des fonctions que l’assistant IA peut appeler pour effectuer des actions. Chaque outil se trouve dans son propre fichier sous tools/ qui exporte une fonction register<Name>Tool, que vous appelez ensuite depuis server.ts. Par exemple, ajoutez tools/my-tool.ts :

tools/my-tool.ts
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
import { z } from 'zod';
export const registerMyTool = (server: McpServer) => {
server.registerTool("toolName", {
description: "tool description",
inputSchema: { param1: z.string(), param2: z.number() } // Input schema using Zod
},
async ({ param1, param2 }) => {
// Tool implementation
return {
content: [{ type: "text", text: "Result" }]
};
}
);
};

Ensuite, enregistrez-le à l’intérieur de createServer dans server.ts :

server.ts
import { registerMyTool } from './tools/my-tool.js';
export const createServer = async () => {
const server = new McpServer({ name: 'my-server', version: '1.0.0' });
registerMyTool(server);
return server;
};

Les ressources fournissent du contexte à l’assistant IA. Comme les outils, chaque ressource se trouve dans son propre fichier sous resources/ qui exporte une fonction register<Name>Resource appelée depuis server.ts. Vous pouvez ajouter des ressources statiques à partir de fichiers ou des ressources dynamiques :

resources/my-resource.ts
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
export const registerMyResource = (server: McpServer) => {
const exampleContext = 'some context to return';
server.registerResource('resource-name', 'example://resource', {}, async (uri) => ({
contents: [{ uri: uri.href, text: exampleContext }],
}));
// Dynamic resource
server.registerResource('dynamic-resource', 'dynamic://resource', {}, async (uri) => {
const data = await fetchSomeData();
return {
contents: [{ uri: uri.href, text: data }],
};
});
};

La plupart des assistants IA qui prennent en charge MCP utilisent une approche de configuration similaire. Vous devrez créer ou mettre à jour un fichier de configuration avec les détails de votre serveur MCP :

{
"mcpServers": {
"your-mcp-server": {
"command": "npx",
"args": ["tsx", "/path/to/your-mcp-server/stdio.ts"]
}
}
}

Lors du développement de votre serveur MCP, vous pouvez souhaiter configurer le flag --watch afin que l’assistant IA voie toujours les dernières versions des outils/ressources :

{
"mcpServers": {
"your-mcp-server": {
"command": "npx",
"args": ["tsx", "--watch", "/path/to/your-mcp-server/stdio.ts"]
}
}
}

Veuillez vous référer à la documentation suivante pour configurer MCP avec des assistants IA spécifiques :

Pour exécuter votre serveur MCP (et tout ce qui y est connecté, comme une base de données locale) localement, utilisez la cible dev du projet :

Terminal window
pnpm nx dev your-project

Si vous avez ajouté plusieurs composants à votre projet (serveurs MCP, agents, etc.), cela les démarre tous. Pour exécuter uniquement ce serveur MCP, ciblez sa cible <your-server-name>-dev :

Terminal window
pnpm nx your-server-name-dev your-project

Le générateur configure une cible nommée <your-server-name>-inspect, qui démarre votre serveur MCP localement (via la cible <your-server-name>-dev, y compris toutes les dépendances connectées telles qu’une base de données locale) et lance l’inspecteur MCP préconfiguré pour s’y connecter via le transport HTTP Streamable.

Terminal window
pnpm nx your-server-name-inspect your-project

Cela démarrera l’inspecteur à http://localhost:6274. Commencez en cliquant sur le bouton « Connect ».

Le moyen le plus simple de tester et d’utiliser un serveur MCP est d’utiliser l’inspecteur ou de le configurer avec un assistant IA (comme ci-dessus).

Vous pouvez cependant exécuter votre serveur avec le transport STDIO directement en utilisant la cible <your-server-name>-serve-stdio.

Terminal window
pnpm nx your-server-name-serve-stdio your-project

Cette commande utilise tsx --watch pour redémarrer automatiquement le serveur lorsque les fichiers changent.

Si vous souhaitez exécuter votre serveur MCP localement en utilisant le transport HTTP Streamable, vous pouvez utiliser la cible <your-server-name>-serve.

Terminal window
pnpm nx your-server-name-serve your-project

Cette commande utilise tsx --watch pour redémarrer automatiquement le serveur lorsque les fichiers changent.

infra = agentcore

Déployer votre serveur MCP sur Bedrock AgentCore Runtime

Section intitulée « Déployer votre serveur MCP sur Bedrock AgentCore Runtime »

Si vous avez sélectionné agentcore pour infra, l’infrastructure CDK ou Terraform pertinente est générée et vous pouvez l’utiliser pour déployer votre serveur MCP sur Amazon Bedrock AgentCore Runtime.

Un construct CDK est généré pour votre serveur MCP, nommé en fonction du name que vous avez choisi lors de l’exécution du générateur, ou <ProjectName>McpServer par défaut.

Vous pouvez utiliser ce construct CDK dans une application CDK :

import { MyProjectMcpServer } from '@my-scope/common-constructs';
export class ExampleStack extends Stack {
constructor(scope: Construct, id: string) {
// Add the MCP server to your stack
new MyProjectMcpServer(this, 'MyProjectMcpServer');
}
}

Le générateur fournit une option auth pour configurer l’authentification de votre serveur MCP. Vous pouvez choisir entre l’authentification IAM (par défaut) ou Cognito lors de la génération de votre serveur MCP.

Par défaut, votre serveur MCP sera sécurisé à l’aide de l’authentification IAM, déployez-le simplement sans aucun argument :

import { MyProjectMcpServer } from '@my-scope/common-constructs';
export class ExampleStack extends Stack {
constructor(scope: Construct, id: string) {
new MyProjectMcpServer(this, 'MyProjectMcpServer');
}
}

Vous pouvez accorder l’accès pour invoquer votre serveur MCP sur Bedrock AgentCore Runtime en utilisant la méthode grantInvokeAccess. Par exemple, vous pouvez souhaiter qu’un agent généré avec le générateur py#agent appelle votre serveur MCP :

import { MyProjectAgent, MyProjectMcpServer } from '@my-scope/common-constructs';
export class ExampleStack extends Stack {
constructor(scope: Construct, id: string) {
const agent = new MyProjectAgent(this, 'MyProjectAgent');
const mcpServer = new MyProjectMcpServer(this, 'MyProjectMcpServer');
mcpServer.grantInvokeAccess(agent);
}
}

Lorsque vous sélectionnez l’authentification Cognito, le générateur configure le serveur MCP pour utiliser Cognito pour l’authentification.

Le construct généré accepte une prop identity qui configure l’authentification Cognito :

import { MyProjectMcpServer, UserIdentity } from '@my-scope/common-constructs';
export class ExampleStack extends Stack {
constructor(scope: Construct, id: string) {
const identity = new UserIdentity(this, 'Identity');
new MyProjectMcpServer(this, 'MyProjectMcpServer', {
identity,
});
}
}

Le construct UserIdentity peut être généré en utilisant le générateur ts#website#auth, ou vous pouvez créer vos propres UserPool et UserPoolClient CDK.

Le générateur configure automatiquement une cible bundle qui utilise Rolldown pour créer un package de déploiement :

Terminal window
pnpm nx bundle <project-name>

La configuration de Rolldown se trouve dans rolldown.config.ts, avec une entrée par bundle à générer. Rolldown gère la création de plusieurs bundles en parallèle s’ils sont définis.

La cible de bundle utilise http.ts comme point d’entrée pour le serveur MCP HTTP Streamable à héberger sur Bedrock AgentCore Runtime.

Le générateur configure une cible <your-server-name>-docker qui copie le Dockerfile depuis le répertoire source de votre serveur MCP dans le répertoire de sortie du bundle. Cela co-localise le Dockerfile avec les artefacts regroupés, permettant à CDK de construire l’image Docker directement en utilisant AgentRuntimeArtifact.fromAsset.

Une cible docker est également générée qui prépare le contexte docker pour tous les serveurs MCP si vous en avez plusieurs définis.

L’image Docker construite pour ce projet peut être analysée pour détecter les vulnérabilités à l’aide de Trivy, exécuté depuis l’image Trivy hébergée sur ECR.

Une cible trivy est ajoutée à votre projet qui analyse l’image construite et se termine avec un code non nul si une vulnérabilité de gravité HIGH ou CRITICAL est trouvée. Le Dockerfile généré utilise une image de base sans vulnérabilité corrigeable connue de ces gravités au moment de la génération, et met à niveau les outils fournis (tels que npm) pour maintenir cet état.

L’analyse utilise le même moteur de conteneur que votre construction d’image (docker ou finch), donc aucun outillage supplémentaire n’est requis. Étant donné que l’analyse n’est réexécutée que lorsque l’image change, une image inchangée n’est pas réanalysée. Le script racine trivy fourni analyse chaque image dans l’espace de travail :

Terminal window
pnpm trivy

Il peut y avoir des cas où vous souhaitez supprimer une vulnérabilité spécifique, par exemple lorsqu’aucun correctif n’est encore disponible et que vous avez évalué le risque comme acceptable.

Ajoutez l’ID de vulnérabilité (un par ligne) au fichier .trivyignore à la racine de votre projet (c’est-à-dire à côté de votre project.json) :

.trivyignore
# node-tar arbitrary file write - not exploitable in our usage
CVE-2024-XXXXX

Pour plus de détails sur le filtrage des résultats, consultez la documentation de filtrage Trivy.

Votre serveur MCP est automatiquement configuré avec l’observabilité en utilisant AWS Distro for Open Telemetry (ADOT), en configurant l’auto-instrumentation dans votre Dockerfile.

Vous pouvez trouver les traces dans la console AWS CloudWatch, en sélectionnant « GenAI Observability » dans le menu. Notez que pour que les traces soient remplies, vous devrez activer Transaction Search.

Pour plus de détails, consultez la documentation AgentCore sur l’observabilité.

Utilisez le générateur connection pour intégrer ce projet avec d’autres dans votre espace de travail. Les connexions suivantes impliquent ce projet :

Strands AgentsTypeScriptModel Context Protocol
TypeScript Agent to MCPConnect a TypeScript Agent to an MCP server
Strands AgentsPythonModel Context Protocol
Python Agent to MCPConnect a Python Agent to an MCP server
Model Context ProtocolAmazon Aurora
MCP Server to Relational DatabaseConnect a TypeScript MCP Server to an Aurora relational database
Model Context ProtocolAmazon DynamoDB
MCP Server to TypeScript DynamoDBConnect a TypeScript MCP Server to a DynamoDB table
Amazon Bedrock AgentCore GatewayModel Context Protocol
AgentCore Gateway to MCP ServerAggregate an MCP server behind an AgentCore Gateway