Salta ai contenuti

TypeScript MCP Server

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

Genera un server TypeScript Model Context Protocol (MCP) per fornire contesto ai Large Language Model (LLM), e opzionalmente distribuiscilo su Amazon Bedrock AgentCore.

Il Model Context Protocol (MCP) è uno standard aperto che consente agli assistenti AI di interagire con strumenti e risorse esterne. Fornisce un modo coerente per gli LLM di:

  • Eseguire strumenti (funzioni) che eseguono azioni o recuperano informazioni
  • Accedere a risorse che forniscono contesto o dati

Puoi generare un server MCP TypeScript in due modi:

Terminal window
pnpm nx g @aws/nx-plugin:ts#mcp-server
Puoi anche eseguire una prova per vedere quali file verrebbero modificati
Terminal window
pnpm nx g @aws/nx-plugin:ts#mcp-server --dry-run
ParametroTipoPredefinitoDescrizione
project Obbligatoriostring-Il progetto a cui aggiungere un server MCP
name string-Il nome del tuo server MCP (default: mcp-server)
auth iam | cognitoiamIl metodo utilizzato per autenticare con il tuo server MCP. Applicabile solo quando infra è impostato (ignorato quando infra è none).
iac inherit | cdk | terraforminheritIl provider IaC preferito. Per impostazione predefinita viene ereditato dalla selezione iniziale.
infra agentcore | noneagentcoreIl tipo di infrastruttura per ospitare il tuo server MCP. Seleziona none per nessun hosting.
preferInstallDependencies booleantrueSe preferire l'installazione delle dipendenze dopo l'esecuzione del generatore. Impostare su false per rimandare l'installazione quando si eseguono più generatori in batch (l'installazione viene comunque eseguita se necessaria affinché i generatori successivi possano calcolare il grafo dei progetti Nx); installare una volta alla fine.

Il generatore aggiungerà i seguenti file al tuo progetto TypeScript esistente:

  • Directoryyour-project/
    • Directorysrc/
      • Directorymcp-server/ (o nome personalizzato se specificato)
        • index.ts Esporta il tuo server
        • server.ts Definizione principale del server
        • stdio.ts Punto di ingresso per il trasporto STDIO, utile per semplici MCP server locali
        • http.ts Punto di ingresso per il trasporto HTTP Streamable, utile per ospitare il tuo MCP server
        • Directorytools/
          • divide.ts Strumento di esempio
        • Directoryresources/
          • sample-guidance.ts Risorsa di esempio
        • Dockerfile Punto di ingresso per ospitare il tuo MCP server (escluso quando infra è impostato su None)
    • project.json Aggiornato con il target serve dell’MCP server
infra = agentcore

Poiché questo generatore fornisce infrastruttura come codice basata sul tuo iac scelto, creerà un progetto in packages/common che include i costrutti CDK o i moduli Terraform pertinenti.

Il progetto comune di infrastruttura come codice è strutturato come segue:

  • Directorypackages/common/constructs
    • Directorysrc
      • Directoryapp/ Constructs for infrastructure specific to a project/generator
      • Directorycore/ Generic constructs which are reused by constructs in app
      • index.ts Entry point exporting constructs from app
    • project.json Project build targets and configuration

Per il deployment del tuo MCP Server, vengono generati i seguenti file:

  • Directorypackages/common/constructs/src
    • Directoryapp
      • Directorymcp-servers
        • Directory<mcp-server-name>
          • <mcp-server-name>.ts CDK construct for deploying your MCP Server
infra = none

Se hai selezionato none per infra, non vengono generati costrutti CDK o moduli Terraform — il server MCP è configurato solo per l’uso locale STDIO / HTTP. L’opzione auth viene ignorata in questa modalità poiché non c’è un endpoint ospitato da autenticare.

Quando viene distribuito su Bedrock AgentCore Runtime, il server MCP viene costruito in un’immagine container, caricato su Amazon ECR ed eseguito in AgentCore Runtime. Gli assistenti AI invocano l’endpoint del data plane di AgentCore Runtime, che inoltra le chiamate tools/* e resources/* al tuo server tramite il trasporto HTTP streamable.

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

Gli strumenti sono funzioni che l’assistente AI può chiamare per eseguire azioni. Ogni strumento risiede nel proprio file sotto tools/ che esporta una funzione register<Name>Tool, che poi chiami da server.ts. Ad esempio, aggiungi 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" }]
};
}
);
};

Poi registralo all’interno di createServer in 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;
};

Le risorse forniscono contesto all’assistente AI. Come gli strumenti, ogni risorsa risiede nel proprio file sotto resources/ che esporta una funzione register<Name>Resource chiamata da server.ts. Puoi aggiungere risorse statiche da file o risorse dinamiche:

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 maggior parte degli assistenti AI che supportano MCP utilizza un approccio di configurazione simile. Dovrai creare o aggiornare un file di configurazione con i dettagli del tuo server MCP:

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

Durante lo sviluppo del tuo server MCP, potresti voler configurare il flag --watch in modo che l’assistente AI veda sempre le versioni più recenti di strumenti/risorse:

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

Si prega di fare riferimento alla seguente documentazione per configurare MCP con specifici Assistenti AI:

Per eseguire il tuo server MCP (e tutto ciò che è connesso ad esso, come un database locale) localmente, usa il target dev del progetto:

Terminal window
pnpm nx dev your-project

Se hai aggiunto più componenti al tuo progetto (server MCP, agenti, ecc.), questo li avvia tutti. Per eseguire solo questo server MCP, punta al suo target <your-server-name>-dev:

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

Il generatore configura un target denominato <your-server-name>-inspect, che avvia il tuo server MCP localmente (tramite il target <your-server-name>-dev, incluse eventuali dipendenze connesse come un database locale) e lancia l’MCP Inspector preconfigurato per connettersi ad esso tramite trasporto HTTP Streamable.

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

Questo avvierà l’inspector su http://localhost:6274. Inizia cliccando sul pulsante “Connect”.

Il modo più semplice per testare e utilizzare un server MCP è utilizzare l’inspector o configurarlo con un assistente AI (come sopra).

Puoi tuttavia eseguire il tuo server con trasporto STDIO direttamente utilizzando il target <your-server-name>-serve-stdio.

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

Questo comando utilizza tsx --watch per riavviare automaticamente il server quando i file cambiano.

Se desideri eseguire il tuo server MCP localmente utilizzando trasporto HTTP Streamable, puoi utilizzare il target <your-server-name>-serve.

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

Questo comando utilizza tsx --watch per riavviare automaticamente il server quando i file cambiano.

infra = agentcore

Distribuire il Tuo MCP Server su Bedrock AgentCore Runtime

Sezione intitolata “Distribuire il Tuo MCP Server su Bedrock AgentCore Runtime”

Se hai selezionato agentcore per infra, viene generata l’infrastruttura CDK o Terraform rilevante che puoi utilizzare per distribuire il tuo server MCP su Amazon Bedrock AgentCore Runtime.

Viene generato un costrutto CDK per il tuo server MCP, denominato in base al name che hai scelto durante l’esecuzione del generatore, o <ProjectName>McpServer per impostazione predefinita.

Puoi utilizzare questo costrutto CDK in un’applicazione 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');
}
}

Il generatore fornisce un’opzione auth per configurare l’autenticazione per il tuo server MCP. Puoi scegliere tra autenticazione IAM (predefinita) o Cognito durante la generazione del tuo server MCP.

Per impostazione predefinita, il tuo server MCP sarà protetto utilizzando l’autenticazione IAM, semplicemente distribuiscilo senza alcun argomento:

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

Puoi concedere l’accesso per invocare il tuo server MCP su Bedrock AgentCore Runtime utilizzando il metodo grantInvokeAccess. Ad esempio, potresti desiderare che un agente generato con il generatore py#agent chiami il tuo server 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);
}
}

Quando selezioni l’autenticazione Cognito, il generatore configura il server MCP per utilizzare Cognito per l’autenticazione.

Il costrutto generato accetta una prop identity che configura l’autenticazione 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,
});
}
}

Il costrutto UserIdentity può essere generato utilizzando il generatore ts#website#auth, oppure puoi creare il tuo UserPool e UserPoolClient CDK.

Il generatore configura automaticamente un target bundle che utilizza Rolldown per creare un pacchetto di distribuzione:

Terminal window
pnpm nx bundle <project-name>

La configurazione di Rolldown si trova in rolldown.config.ts, con una voce per ogni bundle da generare. Rolldown gestisce la creazione di più bundle in parallelo se definiti.

Il target bundle utilizza http.ts come punto di ingresso per il server MCP HTTP Streamable da ospitare su Bedrock AgentCore Runtime.

Il generatore configura un target <your-server-name>-docker che copia il Dockerfile dalla directory sorgente del tuo server MCP nella directory di output del bundle. Questo co-localizza il Dockerfile con gli artefatti del bundle, consentendo a CDK di costruire l’immagine Docker direttamente utilizzando AgentRuntimeArtifact.fromAsset.

Viene anche generato un target docker che prepara il contesto docker per tutti i server MCP se ne hai definiti più di uno.

L’immagine Docker costruita per questo progetto può essere scansionata per vulnerabilità utilizzando Trivy, eseguito dall’immagine Trivy ospitata su ECR.

Un target trivy viene aggiunto al tuo progetto che scansiona l’immagine costruita ed esce con codice diverso da zero se viene trovata qualsiasi vulnerabilità di gravità HIGH o CRITICAL. Il Dockerfile generato utilizza un’immagine base senza vulnerabilità risolvibili note di queste gravità al momento della generazione, e aggiorna gli strumenti inclusi (come npm) per mantenerla tale.

La scansione utilizza lo stesso motore container della tua build dell’immagine (docker o finch), quindi non sono richiesti strumenti aggiuntivi. Poiché la scansione viene rieseguita solo quando l’immagine cambia, un’immagine non modificata non viene scansionata nuovamente. Lo script root trivy fornito scansiona ogni immagine nel workspace:

Terminal window
pnpm trivy

Potrebbero esserci casi in cui desideri sopprimere una vulnerabilità specifica, ad esempio quando non è ancora disponibile una correzione e hai valutato il rischio come accettabile.

Aggiungi l’ID della vulnerabilità (uno per riga) al file .trivyignore nella root del tuo progetto (cioè accanto al tuo project.json):

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

Per maggiori dettagli sul filtraggio dei risultati, consulta la documentazione sul filtraggio di Trivy.

Il tuo server MCP è configurato automaticamente con l’osservabilità utilizzando AWS Distro for Open Telemetry (ADOT), configurando l’auto-strumentazione nel tuo Dockerfile.

Puoi trovare le tracce nella Console AWS CloudWatch, selezionando “GenAI Observability” nel menu. Nota che affinché le tracce vengano popolate dovrai abilitare Transaction Search.

Per maggiori dettagli, consulta la documentazione AgentCore sull’osservabilità.

Usa il generatore connection per integrare questo progetto con altri nel tuo workspace. Le seguenti connessioni coinvolgono questo progetto:

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