Skip to content

Commit 4d48b62

Browse files
committed
Sync open source content 🐝 (from 988274eb2d3d4a2ab09125eca87516aebb9a2b7c)
1 parent e6fd31f commit 4d48b62

23 files changed

+28
-28
lines changed

docs/gram/api-clients/using-vellum-workflows-sdk-with-gram-mcp-servers.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you already have a Gram MCP server configured, you can skip to [connecting Ve
2929

3030
In the [Gram dashboard](https://app.getgram.ai), click **New Project** to create a new project. Enter a project name and click **Submit**
3131

32-
![Screenshot of the Gram dashboard showing the New Project modal](./assets/gram-new-project.png)
32+
![Screenshot of the Gram dashboard showing the New Project modal](/assets/docs/gram/img/api-clients/vellum/gram-new-project.png)
3333

3434
Once you've created the project, click the **Get Started** button.
3535

@@ -39,39 +39,39 @@ Choose **Start from API**. Gram then guides you through the following steps.
3939

4040
Upload the [Push Advisor OpenAPI document](https://github.com/ritza-co/gram-examples/blob/main/push-advisor-api/openapi.yaml), enter the name of your API, and click **Continue**.
4141

42-
![Screenshot of the upload your OpenAPI document dialog](./assets/upload-openapi-spec.png)
42+
![Screenshot of the upload your OpenAPI document dialog](/assets/docs/gram/img/api-clients/vellum/upload-openapi-spec.png)
4343

4444
#### Step 2: Create a toolset
4545

4646
Give your toolset a name (for example, `Push Advisor`) and click **Continue**.
4747

48-
![Screenshot of the create toolset dialog](./assets/create-toolset.png)
48+
![Screenshot of the create toolset dialog](/assets/docs/gram/img/api-clients/vellum/create-toolset.png)
4949

5050
Notice that the **Name Your Toolset** dialog displays the names of the tools that Gram will generate from your OpenAPI document.
5151

5252
#### Step 3: Configure MCP
5353

5454
Enter a URL slug for the MCP server and click **Continue**.
5555

56-
![Screenshot of the configure MCP dialog](./assets/configure-mcp.png)
56+
![Screenshot of the configure MCP dialog](/assets/docs/gram/img/api-clients/vellum/configure-mcp.png)
5757

5858
Gram will create a new toolset from the OpenAPI document.
5959

6060
Click **Toolsets** in the sidebar to view the Push Advisor toolset.
6161

62-
![Screenshot of the Gram dashboard showing the Push Advisor toolset](./assets/toolset-created.png)
62+
![Screenshot of the Gram dashboard showing the Push Advisor toolset](/assets/docs/gram/img/api-clients/vellum/toolset-created.png)
6363

6464
### Configuring environment variables
6565

6666
[Environments](/docs/gram/concepts/environments) store API keys and configuration separately from your toolset logic.
6767

6868
In the **Environments** tab, click the **Default** environment. Click **Fill for Toolset**. Select the **Push Advisor** toolset and click **Fill Variables** to automatically populate the required variables.
6969

70-
![Screenshot showing the fill for toolset dialog to automatically populate required variables](./assets/fill-env-vars-toolset.png)
70+
![Screenshot showing the fill for toolset dialog to automatically populate required variables](/assets/docs/gram/img/api-clients/vellum/fill-env-vars-toolset.png)
7171

7272
The Push Advisor API is hosted at `https://canpushtoprod.abdulbaaridavids04.workers.dev`, so set the `<your_API_name>_SERVER_URL` environment variable to `https://canpushtoprod.abdulbaaridavids04.workers.dev`. Click **Save**.
7373

74-
![Set server URL](./assets/set-server-url.png)
74+
![Set server URL](/assets/docs/gram/img/api-clients/vellum/set-server-url.png)
7575

7676
### Publishing an MCP server
7777

@@ -81,7 +81,7 @@ Go to the **MCP** tab, find the Push Advisor toolset, and click the title of the
8181

8282
On the **MCP Details** page, click **Enable** and then **Enable Server** to enable the server.
8383

84-
![Screenshot of the MCP details page](./assets/mcp-details.png)
84+
![Screenshot of the MCP details page](/assets/docs/gram/img/api-clients/vellum/mcp-details.png)
8585

8686
Take note of your MCP server URL in the **Hosted URL** section.
8787

@@ -142,7 +142,7 @@ A Vellum Workflow has three main components:
142142

143143
For this Workflow, the Agent node can make multiple calls to the MCP server (as many as needed to answer the query).
144144

145-
![Diagram showing the Vellum Workflow with entry point, agent node, and output](./assets/vellum-workflow-diagram.png)
145+
![Diagram showing the Vellum Workflow with entry point, agent node, and output](/assets/docs/gram/img/api-clients/vellum/vellum-workflow-diagram.png)
146146

147147
Inside the project directory, create a file called `workflow.py`. Start by defining the input structure:
148148

@@ -322,7 +322,7 @@ uv run python workflow.py "Is it safe to push to production today?"
322322

323323
The output shows the agent's response after it queries the MCP server and evaluates whether pushing to production is safe.
324324

325-
![Screenshot of the Workflow output showing the agent's response about pushing to production](./assets/vellum-workflow-output.png)
325+
![Screenshot of the Workflow output showing the agent's response about pushing to production](/assets/docs/gram/img/api-clients/vellum/vellum-workflow-output.png)
326326

327327
## What's next
328328

docs/gram/clients/using-vellum-agents-with-gram-mcp-servers.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you already have a Gram MCP server configured, you can skip to [connecting Ve
2626

2727
In the [Gram dashboard](https://app.getgram.ai), click **New Project** to create a new project. Enter a project name and click **Submit**
2828

29-
![Screenshot of the Gram dashboard showing the New Project modal](./assets/gram-new-project.png)
29+
![Screenshot of the Gram dashboard showing the New Project modal](/assets/docs/gram/img/api-clients/vellum/gram-new-project.png)
3030

3131
Once you've created the project, click the **Get Started** button.
3232

@@ -36,39 +36,39 @@ Choose **Start from API**. Gram then guides you through the following steps.
3636

3737
Upload the [Push Advisor OpenAPI document](https://github.com/ritza-co/gram-examples/blob/main/push-advisor-api/openapi.yaml), enter the name of your API, and click **Continue**.
3838

39-
![Screenshot of the upload your OpenAPI document dialog](./assets/upload-openapi-spec.png)
39+
![Screenshot of the upload your OpenAPI document dialog](/assets/docs/gram/img/api-clients/vellum/upload-openapi-spec.png)
4040

4141
#### Step 2: Create a toolset
4242

4343
Give your toolset a name (for example, `Push Advisor`) and click **Continue**.
4444

45-
![Screenshot of the create toolset dialog](./assets/create-toolset.png)
45+
![Screenshot of the create toolset dialog](/assets/docs/gram/img/api-clients/vellum/create-toolset.png)
4646

4747
Notice that the **Name Your Toolset** dialog displays the names of the tools that Gram will generate from your OpenAPI document.
4848

4949
#### Step 3: Configure MCP
5050

5151
Enter a URL slug for the MCP server and click **Continue**.
5252

53-
![Screenshot of the configure MCP dialog](./assets/configure-mcp.png)
53+
![Screenshot of the configure MCP dialog](/assets/docs/gram/img/api-clients/vellum/configure-mcp.png)
5454

5555
Gram will create a new toolset from the OpenAPI document.
5656

5757
Click **Toolsets** in the sidebar to view the Push Advisor toolset.
5858

59-
![Screenshot of the Gram dashboard showing the Push Advisor toolset](./assets/toolset-created.png)
59+
![Screenshot of the Gram dashboard showing the Push Advisor toolset](/assets/docs/gram/img/api-clients/vellum/toolset-created.png)
6060

6161
### Configuring environment variables
6262

6363
[Environments](/docs/gram/concepts/environments) store API keys and configuration separately from your toolset logic.
6464

6565
In the **Environments** tab, click the **Default** environment. Then click **Fill for Toolset**, select the **Push Advisor** toolset, and click **Fill Variables** to automatically populate the required variables.
6666

67-
![Screenshot showing the fill for toolset dialog to automatically populate required variables](./assets/fill-env-vars-toolset.png)
67+
![Screenshot showing the fill for toolset dialog to automatically populate required variables](/assets/docs/gram/img/api-clients/vellum/fill-env-vars-toolset.png)
6868

6969
The Push Advisor API is hosted at `https://canpushtoprod.abdulbaaridavids04.workers.dev`, so set the `<your_API_name>_SERVER_URL` environment variable to `https://canpushtoprod.abdulbaaridavids04.workers.dev`. Click **Save**.
7070

71-
![Set server URL](./assets/set-server-url.png)
71+
![Set server URL](/assets/docs/gram/img/api-clients/vellum/set-server-url.png)
7272

7373
### Publishing an MCP server
7474

@@ -78,7 +78,7 @@ Go to the **MCP** tab, find the Push Advisor toolset, and click the title of the
7878

7979
On the **MCP Details** page, click **Enable** and then **Enable Server** to enable the server.
8080

81-
![Screenshot of the MCP details page](./assets/mcp-details.png)
81+
![Screenshot of the MCP details page](/assets/docs/gram/img/api-clients/vellum/mcp-details.png)
8282

8383
Take note of your MCP server URL in the **Hosted URL** section.
8484

@@ -92,11 +92,11 @@ With the Push Advisor MCP server ready, you can connect it to Vellum by configur
9292

9393
Configuring the MCP server requires your Gram Key. To add it as a secret, navigate to **Profile → Settings → Secrets & Variables → + Add Environment Variable**.
9494

95-
![Screenshot of Vellum profile settings page](./assets/vellum-profile-settings.png)
95+
![Screenshot of Vellum profile settings page](/assets/docs/gram/img/api-clients/vellum/vellum-profile-settings.png)
9696

9797
Enter `GRAM_KEY` for the variable name, paste your Gram key as the value, and click **Create Variable**.
9898

99-
![Screenshot of creating the GRAM_KEY environment variable in Vellum](./assets/vellum-create-gram-key-variable.png)
99+
![Screenshot of creating the GRAM_KEY environment variable in Vellum](/assets/docs/gram/img/api-clients/vellum/vellum-create-gram-key-variable.png)
100100

101101
## Adding a Vellum agent
102102

@@ -110,15 +110,15 @@ Otherwise, use the **Create Workflow** button to create a new Workflow:
110110

111111
- Add an **Agent** node.
112112

113-
![Screenshot of adding an agent node to a Vellum Workflow](./assets/vellum-add-agent-node.png)
113+
![Screenshot of adding an agent node to a Vellum Workflow](/assets/docs/gram/img/api-clients/vellum/vellum-add-agent-node.png)
114114

115115
- Click the **Agent** node, then click **+ Tool**.
116116

117-
![Screenshot of the Add Tool button in the agent node](./assets/vellum-add-tool-button.png)
117+
![Screenshot of the Add Tool button in the agent node](/assets/docs/gram/img/api-clients/vellum/vellum-add-tool-button.png)
118118

119119
- Select **MCP Server** from the **Tool Type** options.
120120

121-
![Screenshot of selecting MCP Server from the tool options](./assets/vellum-select-mcp-server.png)
121+
![Screenshot of selecting MCP Server from the tool options](/assets/docs/gram/img/api-clients/vellum/vellum-select-mcp-server.png)
122122

123123
- Configure the MCP server as follows:
124124

@@ -128,31 +128,31 @@ Otherwise, use the **Create Workflow** button to create a new Workflow:
128128
- **API Key Header Name:** Authorization
129129
- **API Key Value:** GRAM_KEY
130130

131-
![Screenshot of the MCP server configuration modal in Vellum](./assets/vellum-configure-mcp-server.png)
131+
![Screenshot of the MCP server configuration modal in Vellum](/assets/docs/gram/img/api-clients/vellum/vellum-configure-mcp-server.png)
132132

133133
- Click **Confirm** to save.
134134

135135
Vellum automatically discovers the available tools. You should see the MCP server listed under **Tools**.
136136

137137
- Now, go to the **Overview** tab and click **Edit Prompt** to add a prompt.
138138

139-
![Screenshot of the Edit Prompt button in the agent overview](./assets/vellum-edit-prompt-button.png)
139+
![Screenshot of the Edit Prompt button in the agent overview](/assets/docs/gram/img/api-clients/vellum/vellum-edit-prompt-button.png)
140140

141141
- In the modal, enter this system prompt:
142142

143143
```
144144
Is it safe to push to production today?
145145
```
146146

147-
![Screenshot of adding a system prompt to the agent](./assets/vellum-add-system-prompt.png)
147+
![Screenshot of adding a system prompt to the agent](/assets/docs/gram/img/api-clients/vellum/vellum-add-system-prompt.png)
148148

149149
- Connect the **Entrypoint** node to the **Agent** node, then connect the **Agent** node to the **Output**. Click on the **Output** node and under **Overview → Output Value**, select **Agent** for the **Node Output**, and select **Text** for the **Output Name**.
150150

151-
![Screenshot of connecting Workflow nodes in Vellum](./assets/vellum-connect-workflow-nodes.png)
151+
![Screenshot of connecting Workflow nodes in Vellum](/assets/docs/gram/img/api-clients/vellum/vellum-connect-workflow-nodes.png)
152152

153153
- Click **▶️ Run**. The Workflow should return a response indicating whether pushing to production is safe based on the Push Advisor server's evaluation.
154154

155-
![Screenshot of the Workflow response showing the agent output](./assets/vellum-workflow-response.png)
155+
![Screenshot of the Workflow response showing the agent output](/assets/docs/gram/img/api-clients/vellum/vellum-workflow-response.png)
156156

157157
## Troubleshooting
158158

docs/gram/api-clients/assets/configure-mcp.png renamed to public/assets/docs/gram/img/api-clients/vellum/configure-mcp.png

File renamed without changes.

docs/gram/api-clients/assets/create-toolset.png renamed to public/assets/docs/gram/img/api-clients/vellum/create-toolset.png

File renamed without changes.

docs/gram/api-clients/assets/fill-env-vars-toolset.png renamed to public/assets/docs/gram/img/api-clients/vellum/fill-env-vars-toolset.png

File renamed without changes.

docs/gram/api-clients/assets/gram-new-project.png renamed to public/assets/docs/gram/img/api-clients/vellum/gram-new-project.png

File renamed without changes.
98.8 KB
Loading
File renamed without changes.

docs/gram/api-clients/assets/set-server-url.png renamed to public/assets/docs/gram/img/api-clients/vellum/set-server-url.png

File renamed without changes.

docs/gram/api-clients/assets/toolset-created.png renamed to public/assets/docs/gram/img/api-clients/vellum/toolset-created.png

File renamed without changes.

0 commit comments

Comments
 (0)