@aws/run-mcp-servers-with-aws-lambda 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,211 @@
+# Run Model Context Protocol (MCP) servers with AWS Lambda
+
+This project enables you to run [Model Context Protocol](https://modelcontextprotocol.io) stdio-based servers in AWS Lambda functions.
+
+Currently, most implementations of MCP servers and clients are entirely local on a single machine.
+A desktop application such as an IDE or Claude Desktop initiates MCP servers locally as child processes
+and communicates with each of those servers over a long-running stdio stream.
+
+```mermaid
+flowchart LR
+    subgraph "Your Laptop"
+        Host["Desktop Application<br>with MCP Clients"]
+        S1["MCP Server A<br>(child process)"]
+        S2["MCP Server B<br>(child process)"]
+        Host <-->|"MCP Protocol<br>(over stdio stream)"| S1
+        Host <-->|"MCP Protocol<br>(over stdio stream)"| S2
+    end
+```
+
+This MCP server adapter for AWS Lambda helps you to wrap existing stdio MCP servers into Lambda functions.
+You can invoke these function-based MCP servers from your application using the MCP protocol
+over short-lived connections.
+Your application can then be a desktop-based app, a distributed system running in the cloud,
+or any other architecture.
+Your application must have access to invoke your Lambda functions,
+and use the custom MCP client transport that invokes the Lambda functions.
+
+```mermaid
+flowchart LR
+    subgraph "Distributed System"
+        App["Your Application<br>with MCP Clients"]
+        S3["MCP Server A<br>(Lambda function)"]
+        S4["MCP Server B<br>(Lambda function)"]
+        App <-->|"MCP Protocol<br>with custom transport<br>(invoke function)"| S3
+        App <-->|"MCP Protocol<br>with custom transport<br>(invoke function)"| S4
+    end
+```
+
+## Considerations
+
+- This package currently requires using a custom MCP client transport to communicate with the MCP
+  server by invoking the Lambda function. Existing applications with MCP support such as
+  Amazon Q Developer CLI, Cline, etc do not have this custom transport, and cannot communicate with
+  MCP servers adapted into Lambda functions.
+  Note: with [upcoming changes to the MCP protocol](https://github.com/modelcontextprotocol/specification/pull/206),
+  we expect that this limitation will be removed in the future.
+- This package currently supports MCP servers and clients written in Python and Typescript.
+  Other languages such as Kotlin are not supported.
+- The server adapters only adapt stdio MCP servers, not servers written for other protocols such as SSE.
+- The server adapters do not maintain any MCP server state across Lambda function invocations.
+  Only stateless MCP servers are a good fit for using this adapter. For example, MCP servers
+  that invoke stateless tools like the [time MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/time)
+  or make stateless web requests like the [fetch MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch).
+  Stateful MCP servers are not a good fit, because they will lose their state on every request.
+  For example, MCP servers that manage data on disk or in memory such as
+  the [sqlite MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite),
+  the [filesystem MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem),
+  and the [git MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/git).
+- The server adapters ignore any MCP protocol notifications from the client to the server.
+- The server adapters do not provide mechanisms for managing any secrets needed by the wrapped
+  MCP server. For example, the [GitHub MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/github)
+  and the [Brave search MCP server](https://github.com/modelcontextprotocol/servers/tree/main/src/brave-search)
+  require API keys to make requests to third-party APIs.
+  You can configure these API keys as
+  [encrypted environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars-encryption.html)
+  in the Lambda function's configuration. However, note that anyone with access to invoke the Lambda function
+  will then have access to use your API key to call the third-party APIs by invoking the function.
+  We recommend limiting access to the Lambda function using
+  [least-privilege IAM policies](https://docs.aws.amazon.com/lambda/latest/dg/security-iam.html).
+
+## Examples
+
+### Python server example
+
+This project includes an
+[example Python Lambda function](examples/servers/time/function/index.py)
+that runs the simple
+[MCP 'time' reference server](https://github.com/modelcontextprotocol/servers/tree/main/src/time).
+The Lambda function bundles the [mcp-server-time package](https://pypi.org/project/mcp-server-time/).
+On each function invocation, the Lambda function will manage the lifecycle of the bundled MCP server.
+It will:
+
+1. start the 'time' MCP server as a child process
+1. initialize the MCP server
+1. forward the incoming request to the local server
+1. return the server's response to the function caller
+1. shut down the MCP server child process
+
+```python
+import sys
+from mcp.client.stdio import StdioServerParameters
+from mcp_lambda import stdio_server_adapter
+
+server_params = StdioServerParameters(
+    command=sys.executable,
+    args=[
+        "-m",
+        "mcp_server_time",
+        "--local-timezone",
+        "America/New_York",
+    ],
+)
+
+
+def handler(event, context):
+    return stdio_server_adapter(server_params, event, context)
+```
+
+### Typescript server example
+
+This project includes an
+[example Node.js Lambda function](examples/servers/weather-alerts/lib/weather-alerts-mcp-server.function.ts)
+that runs an [OpenAPI MCP server](https://github.com/snaggle-ai/openapi-mcp-server/)
+to provide a single API from [weather.gov](https://www.weather.gov/documentation/services-web-api) as a tool.
+The Lambda function bundles the [openapi-mcp-server package](https://www.npmjs.com/package/openapi-mcp-server).
+On each function invocation, the Lambda function will manage the lifecycle of the bundled MCP server.
+It will:
+
+1. start the 'openapi-mcp-server' MCP server as a child process
+1. initialize the MCP server
+1. forward the incoming request to the local server
+1. return the server's response to the function caller
+1. shut down the MCP server child process
+
+```typescript
+import { Handler, Context } from "aws-lambda";
+
+const serverParams = {
+  command: "npx",
+  args: ["--offline", "openapi-mcp-server", "./weather-alerts-openapi.json"],
+};
+
+export const handler: Handler = async (event, context: Context) => {
+  // Dynamically import ES module into CommonJS Lambda function
+  const { stdioServerAdapter } = await import(
+    "@aws/run-mcp-servers-with-aws-lambda"
+  );
+
+  return await stdioServerAdapter(serverParams, event, context);
+};
+```
+
+### Python client example
+
+This project includes an
+[example Python MCP client](examples/chatbots/python/server_clients/lambda_function.py)
+that invokes the 'time' MCP server function from above.
+The client invokes a Lambda function named "mcp-server-time" with a payload that is compliant
+with the MCP protocol and returns the function's response to the caller.
+
+```python
+from mcp import ClientSession
+from mcp_lambda import LambdaFunctionParameters, lambda_function_client
+
+server_params = LambdaFunctionParameters(
+    function_name="mcp-server-time",
+    region_name="us-east-2",
+)
+
+read, write = await lambda_function_client(server_params)
+session = ClientSession(read, write)
+await session.initialize()
+```
+
+### Typescript client example
+
+This project includes an
+[example Typescript MCP client](examples/chatbots/typescript/src/server_clients/lambda_function.ts)
+that invokes the 'time' MCP server function from above.
+The client invokes a Lambda function named "mcp-server-time" with a payload that is compliant
+with the MCP protocol and returns the function's response to the caller.
+
+```typescript
+import {
+  LambdaFunctionParameters,
+  LambdaFunctionClientTransport,
+} from "@aws/run-mcp-servers-with-aws-lambda";
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+
+const serverParams: LambdaFunctionParameters = {
+  functionName: "mcp-server-time",
+  regionName: "us-east-2",
+};
+
+const client = new Client(
+  {
+    name: "my-client",
+    version: "0.0.1",
+  },
+  {
+    capabilities: {
+      sampling: {},
+    },
+  }
+);
+
+const transport = new LambdaFunctionClientTransport(serverParams);
+await client.connect(transport);
+```
+
+### Deploy and run the examples
+
+See the [development guide](DEVELOP.md) for instructions to deploy and run the examples in this repository.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws/run-mcp-servers-with-aws-lambda",
   "description": "Run Model Context Protocol (MCP) servers with AWS Lambda",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "license": "Apache-2.0",
   "author": {