Skip to content

Commit a9ae8f3

Browse files
Update gendocs to add toolsmetadata and exclusion list (#819)
* feat: add exclusion list file reader utility Made-with: Cursor * feat: add utility to remove excluded toolkit output files Made-with: Cursor * chore: export exclusion list utilities from utils index Made-with: Cursor * feat: add --exclude-file option to generate command Made-with: Cursor * feat: add --exclude-file option to generate-all command Made-with: Cursor * docs: document --exclude-file option in README Made-with: Cursor * style: fix passive voice in README exclusion section Made-with: Cursor * Update docs gent to have toolkit metdata in json and exclusion list * Merge branch 'main' into francisco/update-gendocs-to-add-toolsmetadata * Regenerate clean markdown files * chore: add .worktrees to gitignore Made-with: Cursor * adding ignore list logic * Regenerate clean markdown files * test: add failing CLI flow regression tests Made-with: Cursor * fix: add tested CLI flow helpers for skip and provider filtering Made-with: Cursor * fix: make excluded output cleanup resilient to missing directories Made-with: Cursor * fix: run exclusion cleanup when skip-unchanged finds no changes Made-with: Cursor * fix: compute toProcess from effective skip intersection Made-with: Cursor * fix: apply skip and ignore filters in providers mode Made-with: Cursor * fix: make ProviderEntry.version compatible with exactOptionalPropertyTypes Made-with: Cursor * Regenerate clean markdown files --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 0724663 commit a9ae8f3

36 files changed

Lines changed: 1958 additions & 62 deletions

File tree

.github/workflows/generate-toolkit-docs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ jobs:
5959
--llm-api-key "$OPENAI_API_KEY" \
6060
--toolkit-concurrency 8 \
6161
--llm-concurrency 15 \
62+
--exclude-file ./excluded-toolkits.txt \
63+
--ignore-file ./ignored-toolkits.txt \
6264
--output data/toolkits
6365
working-directory: toolkit-docs-generator
6466
env:

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ toolkit-docs-generator-verification/logs/
2828

2929
# Generated toolkit markdown (built at build time, not committed)
3030
public/toolkit-markdown/
31+
32+
# Git worktrees
33+
.worktrees/

app/_components/toolkit-docs/types/index.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,28 @@ export type ToolCodeExample = {
181181
tabLabel?: string;
182182
};
183183

184+
// ============================================================================
185+
// Tool Metadata Types
186+
// ============================================================================
187+
188+
export type ToolMetadataClassification = {
189+
serviceDomains: string[];
190+
};
191+
192+
export type ToolMetadataBehavior = {
193+
operations: string[];
194+
readOnly?: boolean;
195+
destructive?: boolean;
196+
idempotent?: boolean;
197+
openWorld?: boolean;
198+
};
199+
200+
export type ToolMetadata = {
201+
classification: ToolMetadataClassification;
202+
behavior: ToolMetadataBehavior;
203+
extras?: Record<string, unknown> | null;
204+
};
205+
184206
// ============================================================================
185207
// Tool Definition Types
186208
// ============================================================================
@@ -207,6 +229,8 @@ export type ToolDefinition = {
207229
secretsInfo?: ToolSecret[];
208230
/** Tool output schema */
209231
output: ToolOutput | null;
232+
/** Per-tool metadata from Engine API */
233+
metadata?: ToolMetadata | null;
210234
/** Custom documentation chunks for this tool */
211235
documentationChunks: DocumentationChunk[];
212236
/** Generated code example configuration */

app/en/get-started/quickstarts/mcp-server-quickstart/page.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,18 +115,44 @@ MY_SECRET_KEY="my-secret-value"
115115
The generated project includes a `.env.example` file at the project root with the secret key name and example value.
116116
You can rename it to `.env` to start using it.
117117

118+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
119+
<Tabs.Tab>
120+
118121
```bash
119122
mv ../../.env.example ../../.env
120123
```
121124

125+
</Tabs.Tab>
126+
<Tabs.Tab>
127+
128+
```powershell
129+
Copy-Item .env.example .env
130+
```
131+
132+
</Tabs.Tab>
133+
</Tabs>
134+
122135
</Tabs.Tab>
123136
<Tabs.Tab>
124137
You can set the environment variable in your terminal directly with this command:
125138

139+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
140+
<Tabs.Tab>
141+
126142
```bash
127143
export MY_SECRET_KEY="my-secret-value"
128144
```
129145

146+
</Tabs.Tab>
147+
<Tabs.Tab>
148+
149+
```powershell
150+
$env:MY_SECRET_KEY="my-secret-value"
151+
```
152+
153+
</Tabs.Tab>
154+
</Tabs>
155+
130156
</Tabs.Tab>
131157
</Tabs>
132158

app/en/guides/create-tools/tool-basics/build-mcp-server/page.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,18 +182,44 @@ Arcade automatically discovers `.env` files by traversing upward from the curren
182182
The generated project includes a `.env.example` file at the project root with the secret key name and example value.
183183
You can rename it to `.env` to start using it.
184184

185+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
186+
<Tabs.Tab>
187+
185188
```bash
186189
mv ../../.env.example ../../.env
187190
```
188191

192+
</Tabs.Tab>
193+
<Tabs.Tab>
194+
195+
```powershell
196+
Copy-Item .env.example .env
197+
```
198+
199+
</Tabs.Tab>
200+
</Tabs>
201+
189202
</Tabs.Tab>
190203
<Tabs.Tab>
191204
You can set the environment variable in your terminal directly with this command:
192205

206+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
207+
<Tabs.Tab>
208+
193209
```bash
194210
export MY_SECRET_KEY="my-secret-value"
195211
```
196212

213+
</Tabs.Tab>
214+
<Tabs.Tab>
215+
216+
```powershell
217+
$env:MY_SECRET_KEY="my-secret-value"
218+
```
219+
220+
</Tabs.Tab>
221+
</Tabs>
222+
197223
</Tabs.Tab>
198224
</Tabs>
199225

app/en/guides/create-tools/tool-basics/create-tool-secrets/page.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,23 @@ MY_SECRET_KEY="my-secret-value"
7777
The project includes a `.env.example` file at the project root with the secret key name and example value.
7878
You can rename it to `.env` to start using it.
7979

80+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
81+
<Tabs.Tab>
82+
8083
```bash
8184
mv .env.example .env
8285
```
8386

87+
</Tabs.Tab>
88+
<Tabs.Tab>
89+
90+
```powershell
91+
Copy-Item .env.example .env
92+
```
93+
94+
</Tabs.Tab>
95+
</Tabs>
96+
8497
<Callout type="info">
8598
Using a `.env` file is okay for local development, but you should use
8699
the Arcade Dashboard or Arcade CLI for production deployments.
@@ -117,10 +130,23 @@ arcade secret set MY_SECRET_KEY="my-secret-value"
117130
<Tabs.Tab>
118131
You can set the environment variable in your terminal directly with this command:
119132

133+
<Tabs items={["Bash/Zsh (macOS/Linux)", "PowerShell (Windows)"]}>
134+
<Tabs.Tab>
135+
120136
```bash
121137
export MY_SECRET_KEY="my-secret-value"
122138
```
123139

140+
</Tabs.Tab>
141+
<Tabs.Tab>
142+
143+
```powershell
144+
$env:MY_SECRET_KEY="my-secret-value"
145+
```
146+
147+
</Tabs.Tab>
148+
</Tabs>
149+
124150
<Callout type="info">
125151
Using environment variables is okay for local development, but you should use
126152
the Arcade Dashboard or Arcade CLI for production deployments.

public/_markdown/en/get-started/quickstarts/mcp-server-quickstart.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,18 +92,34 @@ MY_SECRET_KEY="my-secret-value"
9292

9393
The generated includes a `.env.example` file at the project root with the secret key name and example value. You can rename it to `.env` to start using it.
9494

95+
### Bash/Zsh (macOS/Linux)
96+
9597
```bash
9698
mv ../../.env.example ../../.env
9799
```
98100

101+
### PowerShell (Windows)
102+
103+
```bash
104+
Copy-Item .env.example .env
105+
```
106+
99107
### Environment Variable
100108

101109
You can set the environment variable in your terminal directly with this command:
102110

111+
### Bash/Zsh (macOS/Linux)
112+
103113
```bash
104114
export MY_SECRET_KEY="my-secret-value"
105115
```
106116

117+
### PowerShell (Windows)
118+
119+
```bash
120+
$env:MY_SECRET_KEY="my-secret-value"
121+
```
122+
107123
## Connect to Arcade to unlock authorized tool calling
108124

109125
Since the Reddit tool accesses information only available to your Reddit , you’ll need to authorize it. For this, you’ll need to create an Arcade account and connect from the terminal, run:
@@ -216,7 +232,7 @@ Ensure you have set the environment variable in your terminal or `.env` file, an
216232
- **Learn how to deploy your server**: [Deploy your MCP server](/guides/deployment-hosting/arcade-deploy.md)
217233

218234

219-
Last updated on January 5, 2026
235+
Last updated on February 10, 2026
220236

221237
[Call tools in IDE/MCP clients](/en/get-started/quickstarts/call-tool-client.md)
222238
[Overview](/en/get-started/agent-frameworks.md)

public/_markdown/en/guides/create-tools/tool-basics/build-mcp-server.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,18 +163,34 @@ Arcade automatically discovers `.env` files by traversing upward from the curren
163163

164164
The generated includes a `.env.example` file at the project root with the secret key name and example value. You can rename it to `.env` to start using it.
165165

166+
### Bash/Zsh (macOS/Linux)
167+
166168
```bash
167169
mv ../../.env.example ../../.env
168170
```
169171

172+
### PowerShell (Windows)
173+
174+
```bash
175+
Copy-Item .env.example .env
176+
```
177+
170178
### Environment Variable
171179

172180
You can set the environment variable in your terminal directly with this command:
173181

182+
### Bash/Zsh (macOS/Linux)
183+
174184
```bash
175185
export MY_SECRET_KEY="my-secret-value"
176186
```
177187

188+
### PowerShell (Windows)
189+
190+
```bash
191+
$env:MY_SECRET_KEY="my-secret-value"
192+
```
193+
178194
## Connect to Arcade to unlock authorized tool calling
179195

180196
Since the Reddit tool accesses information only available to your Reddit , you’ll need to authorize it. For this, you’ll need to create an Arcade account and connect to it from the terminal, run:
@@ -274,7 +290,7 @@ That’s it! Your server is running and connected to your AI assistant.
274290
- **Deploy your server**: [Learn how to deploy your MCP server](/guides/deployment-hosting/arcade-deploy.md)
275291

276292

277-
Last updated on January 5, 2026
293+
Last updated on February 10, 2026
278294

279295
[Compare MCP server types](/en/guides/create-tools/tool-basics/compare-server-types.md)
280296
[Create a tool with auth](/en/guides/create-tools/tool-basics/create-tool-auth.md)

public/_markdown/en/guides/create-tools/tool-basics/create-tool-secrets.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,18 @@ MY_SECRET_KEY="my-secret-value"
7171

7272
The includes a `.env.example` file at the project root with the secret key name and example value. You can rename it to `.env` to start using it.
7373

74+
### Bash/Zsh (macOS/Linux)
75+
7476
```bash
7577
mv .env.example .env
7678
```
7779

80+
### PowerShell (Windows)
81+
82+
```bash
83+
Copy-Item .env.example .env
84+
```
85+
7886
Using a `.env` file is okay for local development, but you should use the Arcade Dashboard or Arcade CLI for production deployments.
7987

8088
### Arcade Dashboard
@@ -104,10 +112,18 @@ The Arcade CLI will make the secret available to your server when it is deploye
104112

105113
You can set the environment variable in your terminal directly with this command:
106114

115+
### Bash/Zsh (macOS/Linux)
116+
107117
```bash
108118
export MY_SECRET_KEY="my-secret-value"
109119
```
110120

121+
### PowerShell (Windows)
122+
123+
```bash
124+
$env:MY_SECRET_KEY="my-secret-value"
125+
```
126+
111127
Using environment variables is okay for local development, but you should use the Arcade Dashboard or Arcade CLI for production deployments.
112128

113129
### Using secrets with stdio transport
@@ -249,7 +265,7 @@ For HTTP transport, view your server’s API docs at [http://127.0.0.1:8000/docs
249265

250266
For security reasons, Local HTTP servers do not currently support tool-level authorization and secrets. If you need to use tool-level authorization or secrets locally, you should use the stdio transport and configure the Arcade API key and secrets in your connection settings. Otherwise, if you intend to expose your HTTP to the public internet with \-level authorization and secrets, please follow the [deploying to the cloud with Arcade Deploy](/guides/deployment-hosting/arcade-deploy.md) guide or the [on-prem MCP server](/guides/deployment-hosting/on-prem.md) guide for secure remote deployment.
251267

252-
Last updated on January 5, 2026
268+
Last updated on February 10, 2026
253269

254270
[Create a tool with auth](/en/guides/create-tools/tool-basics/create-tool-auth.md)
255271
[Access runtime data](/en/guides/create-tools/tool-basics/runtime-data-access.md)

public/_markdown/en/references/mcp/telemetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Arcade MCP Telemtry"
2+
title: "Arcade MCP Telemetry"
33
description: "Learn about what data we track when using arcade-mcp"
44
---
55
[Arcade MCP](/en/references/mcp/python.md)

0 commit comments

Comments
 (0)