@gram-ai/create-function 0.6.2 → 0.7.0

package/gram-template-gram/CONTRIBUTING.md

@@ -23,7 +23,8 @@
 
 ### The Gram Instance
 
-The `Gram` class is the main entry point for defining tools. You create an instance and chain `.tool()` calls to register multiple tools:
+The `Gram` class is the main entry point for defining tools. You create an
+instance and chain `.tool()` calls to register multiple tools:
 
 ```typescript
 import { Gram } from "@gram-ai/functions";
@@ -57,7 +58,6 @@ Each tool requires:
 - **name**: A unique identifier for the tool
 - **description** (optional): Human-readable description of what the tool does
 - **inputSchema**: A Zod schema object defining the expected input parameters
-- **variables** (optional): Environment variables the tool needs
 - **execute**: An async function that implements the tool logic
 
 ### Tool Context
@@ -118,22 +118,23 @@ async execute(ctx, input) {
 }
 ```
 
-#### `ctx.vars`
+#### `ctx.env`
 
-Access to environment variables defined in the tool's `variables` property:
+Access to parsed environment variables defined by the `Gram` instance:
 
 ```typescript
-.tool({
+const gram = new Gram({
+  envSchema: {
+    BASE_URL: z.string().transform((url) => new URL(url)),
+  },
+}).tool({
   name: "api_call",
   inputSchema: { endpoint: z.string() },
-  variables: {
-    API_KEY: { description: "API key for authentication" }
-  },
   async execute(ctx, input) {
-    const apiKey = ctx.vars.API_KEY;
-    // Use apiKey...
+    const baseURL = ctx.env.BASE_URL;
+    // Use baseURL...
   },
-})
+});
 ```
 
 ## Input Validation
@@ -159,7 +160,8 @@ import * as z from "zod/mini";
 
 ### Lax Mode
 
-By default, the framework strictly validates input. You can enable lax mode to allow unvalidated input to pass through:
+By default, the framework strictly validates input. You can enable lax mode to
+allow unvalidated input to pass through:
 
 ```typescript
 const g = new Gram({ lax: true });
@@ -167,41 +169,48 @@ const g = new Gram({ lax: true });
 
 ## Environment Variables
 
-### Runtime Environment
+### Defining Variables
 
-Pass environment variables are read from `process.env` by default, but you can override them when creating the `Gram` instance:
+Environment variables that are used by tools must be defined when instantiating
+the `Gram` class. This is done using a Zod v4 object schema:
 
 ```typescript
-const g = new Gram({
-  env: {
-    API_KEY: "secret-key",
-    BASE_URL: "https://api.example.com",
+import * as z from "zod/mini";
+
+const gram = new Gram({
+  envSchema: {
+    API_KEY: z.string().describe("API key for external service"),
+    BASE_URL: z.string().check(z.url()).describe("Base URL for API requests"),
   },
 });
 ```
 
-If not provided, the framework falls back to `process.env`.
+Whenever a tool wants to access a new environment variable, a definition must be
+added to the `envSchema` if one does not exist. When this Gram Function is
+deployed, end users will then be able to provide values for these variables when
+installing the corresponding MCP servers.
 
-### Tool Variables
+### Runtime Environment
 
-Declare which environment variables a tool needs:
+Environment variables are read from `process.env` by default, but you can
+override them when creating the `Gram` instance. This can be useful for testing
+or local development. Example:
 
 ```typescript
-.tool({
-  name: "weather",
-  inputSchema: { city: z.string() },
-  variables: {
-    WEATHER_API_KEY: {
-      description: "API key for weather service"
-    }
+const g = new Gram({
+  envSchema: {
+    API_KEY: z.string().describe("API key for external service"),
+    BASE_URL: z.string().check(z.url()).describe("Base URL for API requests"),
   },
-  async execute(ctx, input) {
-    const apiKey = ctx.vars.WEATHER_API_KEY;
-    // Make API call...
+  env: {
+    API_KEY: "secret-key",
+    BASE_URL: "https://api.example.com",
   },
-})
+});
 ```
 
+If not provided, the framework falls back to `process.env`.
+
 ## Response Types
 
 The framework supports multiple response types. All response methods return Web API `Response` objects.

package/gram-template-gram/README.md

@@ -23,7 +23,7 @@ Gram Functions are tools for LLMs and MCP servers that can do arbitrary tasks
 such as fetching data from APIs, performing calculations, or interacting with
 hosted databases.
 
-## Getting Started
+## Quick start
 
 To get started, install dependencies and run the development server:
 
@@ -37,6 +37,12 @@ To build a zip file that can be deployed to Gram, run:
 pnpm build
 ```
 
+After building, push your function to Gram with:
+
+```bash
+pnpm push
+```
+
 ## Testing Locally
 
 If you want to poke at the tools you've built during local development, you can

package/gram-template-gram/gitignore

@@ -6,4 +6,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
-*.tsbuildinfo
+*.tsbuildinfo
+gram.deploy.json

package/gram-template-gram/package.json

@@ -21,7 +21,8 @@
   "scripts": {
     "dev": "mcp-inspector node ./src/server.ts",
     "lint": "tsc --noEmit",
-    "_:build": "gram-build",
+    "_:build": "gf build",
+    "push": "gf push",
     "prebuild": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run build"
   },

package/gram-template-mcp/README.md

@@ -0,0 +1,49 @@
+# Gram Function MCP Template
+
+This template allows you to use the official [MCP TypeScript SDK][mcp-ts] to
+build and deploy [Gram Functions](https://getgram.ai).
+
+[mcp-ts]: https://github.com/modelcontextprotocol/typescript-sdk
+
+Use Gram Functions to build tools and resources for MCP servers. They can do
+arbitrary tasks such as fetching data from APIs, performing calculations, or
+interacting with hosted databases.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org) version 22.18.0 or later
+- [Gram CLI](https://www.speakeasy.com/docs/gram/command-line/use)
+
+## Quick start
+
+To get started, install dependencies and run the development server:
+
+```bash
+pnpm install
+```
+
+To build a zip file that can be deployed to Gram, run:
+
+```bash
+pnpm build
+```
+
+After building, push your function to Gram with:
+
+```bash
+pnpm push
+```
+
+## Testing Locally
+
+If you want to poke at the tools you've built during local development, you can
+start a local MCP server over stdio transport with:
+
+```bash
+pnpm dev
+```
+
+Specifically, this command will spin up [MCP inspector][mcp-inspector] to let
+you interactively test your tools and resources.
+
+[mcp-inspector]: https://github.com/modelcontextprotocol/inspector

package/gram-template-mcp/gitignore

@@ -6,4 +6,5 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 pnpm-debug.log*
-*.tsbuildinfo
+*.tsbuildinfo
+gram.deploy.json

package/gram-template-mcp/package.json

@@ -20,7 +20,8 @@
   },
   "scripts": {
     "dev": "mcp-inspector node ./src/server.ts",
-    "_:build": "gram-build",
+    "_:build": "gf build",
+    "push": "gf push",
     "prebuild": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run build"
   },

package/gram-template-mcp/src/gram.ts

@@ -1,4 +1,10 @@
-import { wrap } from "@gram-ai/functions/mcp";
+import { withGram } from "@gram-ai/functions/mcp";
 import { server } from "./mcp.ts";
 
-export default wrap(server);
+export default withGram(server, {
+  // Describe environment variables required by the function here. These will be
+  // available to fill in the Gram dashboard and hosted MCP servers. Example:
+  // variables: {
+  //   API_KEY: { description: "API key for authentication" },
+  // },
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@gram-ai/create-function",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Build AI tools and deploy them to getgram.ai",
   "keywords": [],
   "homepage": "https://github.com/speakeasy-api/gram",
@@ -38,7 +38,7 @@
     "prettier": "^3.6.2",
     "typescript": "5.9.2",
     "zod": "^3.25.76",
-    "@gram-ai/functions": "^0.6.2"
+    "@gram-ai/functions": "^0.7.0"
   },
   "scripts": {
     "build": "tsc --noEmit false"