Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions skills/uipath-agents/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- Treat "build/create/scaffold/implement a UiPath agent" as the full One-Prompt Flow by default. Do not stop after file creation or local run unless the user explicitly says to stop there.
- A normal completion point is after smoke eval and the mandatory Delivery fork question. A final build summary before that is premature unless run/eval is blocked or the user opted out.
<!--skill-flavor:solution-verb-probe:start-->
- **Probe the `solution` verb once per session before the first scaffold or deploy.** Run `uip solution init --help --output json`. Result `Success` → use `solution init` and `solution deploy run --parent-folder-path` / `--parent-folder-key` (post-rename, default). `unknown command` / non-zero exit → CLI predates the rename; substitute `uip solution new <Name>` and `--folder-path` / `--folder-key` (same arguments otherwise) wherever this skill calls those.

Check warning on line 16 in skills/uipath-agents/SKILL.md

View workflow job for this annotation

GitHub Actions / skills/uipath-agents

Possibly stale `uip solution new` (valid prefix: `solution`)
<!--skill-flavor:solution-verb-probe:end-->
- **Greenfield coded agents — scaffold with `uip codedagent new`, never hand-author the project.** Building a NEW coded agent from scratch: install the framework package in the active venv first, then always create the project with `uip codedagent new <name>` and generate schemas with `uip codedagent init` — never hand-write `pyproject.toml` / `main.py` / `langgraph.json` / `entry-points.json` yourself, even for a trivial agent. Hand-authoring skips required project structure and produces invalid packages. The installed framework package selects the scaffold; after `new`, confirm `<framework>.json` exists — recovery is in [coded/lifecycle/setup.md](references/coded/lifecycle/setup.md) § Verify the Scaffold. (Existing or Studio Web local-workspace projects: do NOT run `uip codedagent new` — follow the project-state gating in [coded/quickstart.md](references/coded/quickstart.md).)
- **Confirm before deleting or uninstalling anything on the tenant** (`uip eval ... delete`, `uip solution deploy uninstall`, `uip solution deploy delete`): name the target and confirm it with the user, unless the user already authorized that exact delete.
Expand Down Expand Up @@ -58,6 +58,7 @@
| Add a client-side tool (conversational only — executes on the client surface, not the server) to a low-code agent | Low-code | [lowcode/lowcode.md](references/lowcode/lowcode.md) § Capability Registry | `lowcode/capabilities/client-side-tools/client-side-tools.md` |
| Add an MCP (Model Context Protocol) server tool to a low-code agent | Low-code | [lowcode/lowcode.md](references/lowcode/lowcode.md) § Capability Registry | `lowcode/capabilities/mcp/mcp.md` |
| Accept files as agent input / call the Analyze Files built-in tool | Low-code | [lowcode/capabilities/built-in-tools/built-in-tools.md](references/lowcode/capabilities/built-in-tools/built-in-tools.md) | `lowcode/capabilities/built-in-tools/analyze-attachments.md`, `lowcode/agent-definition.md` § File Attachments |
| Call a public web API from an inline agent in a Flow (HTTP Request built-in tool — inline agents only, not standalone) | Low-code | [lowcode/capabilities/built-in-tools/built-in-tools.md](references/lowcode/capabilities/built-in-tools/built-in-tools.md) | [lowcode/capabilities/built-in-tools/http-request.md](references/lowcode/capabilities/built-in-tools/http-request.md) |
| Work with file attachments (input, output, or created mid-run) | Coded | [coded/capabilities/file-attachments.md](references/coded/capabilities/file-attachments.md) | |
| Build a conversational (chat-style) agent | Low-code | [lowcode/lowcode.md](references/lowcode/lowcode.md) | `lowcode/project-lifecycle.md`, `lowcode/agent-definition.md` |
| Add a low-code context (Context Grounding RAG / attachments / DataFabric entity set) | Low-code | [lowcode/lowcode.md](references/lowcode/lowcode.md) § Capability Registry | `lowcode/capabilities/context/*` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,10 @@ The author writes the value verbatim into `resource.json` (or into the guardrail

For each resource type's full schema, see the relevant capability file:

- Tool resources (`$resourceType: "tool"`) — [capabilities/process/process.md](capabilities/process/process.md), [capabilities/integration-service/integration-service.md](capabilities/integration-service/integration-service.md)
- Tool resources (`$resourceType: "tool"`), by `type`:
- `process` / `agent` / `api` / `processOrchestration` — [capabilities/process/process.md](capabilities/process/process.md)
- `integration` — [capabilities/integration-service/integration-service.md](capabilities/integration-service/integration-service.md)
- `internal` (built-in tools, selected by `properties.toolType`) — [capabilities/built-in-tools/built-in-tools.md](capabilities/built-in-tools/built-in-tools.md); `http-request` (inline agents in a Flow only) → [capabilities/built-in-tools/http-request.md](capabilities/built-in-tools/http-request.md)
- Context resources (`$resourceType: "context"`) — [capabilities/context/context.md](capabilities/context/context.md)
- Escalation resources (`$resourceType: "escalation"`) — [capabilities/escalation/escalation.md](capabilities/escalation/escalation.md)
- MCP server resources (`$resourceType: "mcp"`) — [capabilities/mcp/mcp.md](capabilities/mcp/mcp.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
| `guardrail.policies` | `[]` |
| `referenceKey` | `null` (non-null identifies an external tool) |
| `isEnabled` | truthy |
| `properties.toolType` | `"batch-transform"` (others: `analyze-attachments`, `load-attachments`, `deep-rag`) |
| `properties.toolType` | `"batch-transform"` (other built-in tools: [../built-in-tools.md § Tool Registry](../built-in-tools.md#tool-registry)) |
| `properties.settings` | Tool config — see [Tool Configuration](#tool-configuration) |

Validator scans `<agent>/resources/**/resource.json`; each `resource.json`'s parent folder must equal its `name`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For coded agents (Python, LangGraph) → [../../../../coded/capabilities/batch-t

Built-in tools are declared in `resources/<name>/resource.json` with `$resourceType: "tool"`, `type: "internal"`, `referenceKey: null`, and `properties.toolType: "batch-transform"`. See [impl-json.md](impl-json.md) for the exact JSON.

Built-in tools accept these `toolType` values: `analyze-attachments`, `load-attachments`, `deep-rag`, `batch-transform`. Anything else fails `uip agent validate`.
Built-in tools accept the `toolType` values in [../built-in-tools.md § Tool Registry](../built-in-tools.md#tool-registry). Anything else fails `uip agent validate` — except `load-attachments`, which passes validation but has no runtime implementation: the agent fails to load. Never use it.

### Tool resource vs context-index resource

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ For process tools (RPA / agent / API / agentic), see [../process/process.md](../
## When to Use

- Agent needs file content analysis at runtime → pair a `job-attachment` input field with `analyze-attachments`
- Inline agent in a Flow needs to call a public web API with no connection → `http-request` (inline agents only — never on a standalone agent)
- Agent needs a platform capability that ships pre-built and does not require deployment

## Critical Rules

1. **Built-in tools are not implicit.** Add them as `resources/{Name}/resource.json` with `type: "internal"` to make them callable. Without the resource file, the tool is unavailable.
2. **`properties.toolType` is the discriminator** — fixed per built-in, kebab-lowercase. Copy from the per-tool walkthrough; do not invent.
3. **No solution-level files.** Built-in tools need no `uip solution resources refresh`. Validate the agent and bundle.
4. **Input/output schemas are fixed.** Do not edit them. Each tool's walkthrough lists the canonical schema.
5. **Inline agents need the flow node too.** When the built-in tool is on an *inline* agent (embedded in a flow), authoring the `resource.json` is **not enough** — also wire a `uipath.agent.resource.tool.builtin.<toolType>` flow node to the autonomous node's `tool` handle. Fetch the node manifest with `uip maestro flow registry get` and hand the node + edge authoring to the `uipath-maestro-flow` skill (Critical Rule 16). Without the flow node the tool is never reachable at runtime. See [../inline-in-flow/inline-in-flow.md](../inline-in-flow/inline-in-flow.md).
4. **Input/output schemas are canonical.** Copy them from the tool's walkthrough and change only what that walkthrough allows.
5. **Inline agents need the flow node too.** When the built-in tool is on an *inline* agent (embedded in a flow), authoring the `resource.json` is **not enough** — also wire the tool's flow node (`uipath.agent.resource.tool.builtin.<name>`, exact type in [§ Tool Registry](#tool-registry) — the suffix is not the `toolType`) to the autonomous node's `tool` handle. Fetch the node manifest with `uip maestro flow registry get` and hand the node + edge authoring to the `uipath-maestro-flow` skill ([Critical Rule 15](../../critical-rules/critical-rules.md)). Without the flow node the tool is never reachable at runtime. **Builder-SDK Flow project (`.flow.ts`):** do not author the `resource.json`. Hand the tool to the `uipath-maestro-flow` skill — it declares the tool on the `inlineAgent` step, and `compile` writes the resource and deletes a hand-written one. A tool the Flow SDK cannot declare is not available to that inline agent — stop and tell the user. See [../inline-in-flow/inline-in-flow.md](../inline-in-flow/inline-in-flow.md).

## Resource Shape

Expand All @@ -28,11 +29,11 @@ For process tools (RPA / agent / API / agentic), see [../process/process.md](../
"type": "internal",
"description": "<TOOL_DESCRIPTION>",
"isEnabled": true,
"inputSchema": { /* fixed per tool */ },
"outputSchema": { /* fixed per tool */ },
"inputSchema": { /* canonical per tool */ },
"outputSchema": { /* canonical per tool */ },
"settings": {},
"guardrail": { "policies": [] },
"argumentProperties": {},
"argumentProperties": {}, // see § Argument Sources
"properties": {
"toolType": "<kebab-lowercase-id>"
}
Expand All @@ -43,11 +44,30 @@ For process tools (RPA / agent / API / agentic), see [../process/process.md](../
|---|---|
| `type` | Always `"internal"` for built-in tools |
| `properties.toolType` | Fixed discriminator (e.g. `"analyze-attachments"`) |
| `inputSchema` / `outputSchema` | Fixed per tool — copy from walkthrough |
| `properties.settings` | Tool-specific configuration, only on the tools whose walkthrough shows it (Deep RAG, Batch Transform). Top-level `settings` stays `{}` |
| `inputSchema` / `outputSchema` | Canonical per tool — copy from walkthrough |
| `argumentProperties` | `{}` unless an argument is pinned — [§ Argument Sources](#argument-sources-argumentproperties) |
| `referenceKey` | Always `null` (no Orchestrator binding) |
| `guardrail.policies` | Always `[]` — required for backward compatibility |
| `id` | Fresh UUID per resource — see [../../critical-rules/critical-rules.md](../../critical-rules/critical-rules.md) Anti-pattern 9 |

## Argument Sources (`argumentProperties`)

The model fills every tool argument unless `argumentProperties` pins it. Keys are JSONPath into the tool input: `$['<ARGUMENT>']`.

| `variant` | Entry | Effect |
|---|---|---|
| *(no entry)* | — | Model fills the argument on each call, guided by its `description` in `inputSchema` |
| `static` | `{ "variant": "static", "value": <VALUE>, "isSensitive": false }` | Fixed value. `<VALUE>` has the argument's JSON type (string, number, array, object) |
| `argument` | `{ "variant": "argument", "argumentPath": "$['<AGENT_INPUT_FIELD>']", "isSensitive": false }` | Value read from the agent's input at run time. The field must exist in `agent.json` → `inputSchema` |

1. **`isSensitive` is required** on `static` and `argument` entries. `uip agent validate` does not check it; an entry without it stops the agent from loading at run time.
2. **`isSensitive: true` only hides a pinned value from the model.** The value is still plain text in `resource.json` — never pin a secret.
3. **`uip agent validate` does not check keys or paths.** A misspelled key pins nothing; an `argument` entry whose agent input is absent at run time leaves the argument to the model.
4. **Leave other variants alone.** `textBuilder` and `objectBuilder` entries are written by Agent Builder and the Flow canvas; keep them as found when editing an existing resource.

Worked example: [http-request.md § Pin Arguments](http-request.md#pin-arguments).

## Lifecycle

1. **Author** the agent-level `resources/{ToolName}/resource.json` with the canonical shape from the per-tool walkthrough.
Expand All @@ -57,12 +77,15 @@ For process tools (RPA / agent / API / agentic), see [../process/process.md](../

## Tool Registry

| Tool | `toolType` | Walkthrough |
|---|---|---|
| Analyze Files | `analyze-attachments` | [analyze-attachments.md](analyze-attachments.md) |
| Create File | `create-file` | [create-file.md](create-file.md) |
| Deep RAG | `deep-rag` | [deeprag/impl-json.md](deeprag/impl-json.md) |
| Batch Transform | `batch-transform` | [batch-transform/impl-json.md](batch-transform/impl-json.md) |
| Tool | `toolType` | Flow node (inline agents) | Walkthrough |
|---|---|---|---|
| Analyze Files | `analyze-attachments` | `uipath.agent.resource.tool.builtin.analyzefiles` | [analyze-attachments.md](analyze-attachments.md) |
| Create File | `create-file` | `uipath.agent.resource.tool.builtin.createfile` | [create-file.md](create-file.md) |
| Deep RAG | `deep-rag` | `uipath.agent.resource.tool.builtin.summarize` | [deeprag/impl-json.md](deeprag/impl-json.md) |
| Batch Transform | `batch-transform` | `uipath.agent.resource.tool.builtin.batchtransform` | [batch-transform/impl-json.md](batch-transform/impl-json.md) |
| HTTP Request — inline agents only | `http-request` | `uipath.agent.resource.tool.builtin.httprequest` | [http-request.md](http-request.md) |

Not every tool is available to every agent: HTTP Request is for inline agents in a Flow only. Each walkthrough states where its tool works — read it before adding the tool.

## Gotchas

Expand All @@ -72,5 +95,7 @@ For process tools (RPA / agent / API / agentic), see [../process/process.md](../
## References

- [analyze-attachments.md](analyze-attachments.md) — Analyze Files walkthrough
- [create-file.md](create-file.md) — Create File walkthrough
- [http-request.md](http-request.md) — HTTP Request walkthrough
- [../../agent-definition.md](../../agent-definition.md) § File Attachments — `job-attachment` schema
- [../../critical-rules/critical-rules.md](../../critical-rules/critical-rules.md) — canonical rules
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
| `guardrail.policies` | `[]` |
| `referenceKey` | `null` (non-null identifies an external tool) |
| `isEnabled` | truthy |
| `properties.toolType` | `"deep-rag"` (others: `analyze-attachments`, `load-attachments`, `batch-transform`) |
| `properties.toolType` | `"deep-rag"` (other built-in tools: [../built-in-tools.md § Tool Registry](../built-in-tools.md#tool-registry)) |
| `properties.settings` | Tool config — see [Tool Configuration](#tool-configuration) |

Validator scans `<agent>/resources/**/resource.json`; each `resource.json`'s parent folder must equal its `name`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For coded agents (Python, LangGraph) → [../../../../coded/capabilities/deeprag

Built-in tools are declared in `resources/<name>/resource.json` with `$resourceType: "tool"`, `type: "internal"`, `referenceKey: null`, and `properties.toolType: "deep-rag"`. See [impl-json.md](impl-json.md) for the exact JSON.

Built-in tools accept these `toolType` values: `analyze-attachments`, `load-attachments`, `deep-rag`, `batch-transform`. Anything else fails `uip agent validate`.
Built-in tools accept the `toolType` values in [../built-in-tools.md § Tool Registry](../built-in-tools.md#tool-registry). Anything else fails `uip agent validate` — except `load-attachments`, which passes validation but has no runtime implementation: the agent fails to load. Never use it.

### Tool resource vs context-index resource

Expand All @@ -37,7 +37,6 @@ Two valid shapes for enabling DeepRAG on a low-code agent. This skill documents
| Decision | Rule |
|---|---|
| `deep-rag` vs `analyze-attachments` | Prefer `deep-rag`. It handles larger files, returns citations (with optional bounding-box anchors), and produces denser output. `analyze-attachments` is one-shot synthesis with lower page limits — reach for it only when the document is small and the task is a single-shot extraction. |
| `deep-rag` vs `load-attachments` | `load-attachments` only makes attachment text available to the agent; `deep-rag` runs an iterative synthesis pass. Use `load-attachments` when the agent will reason directly over short contents; use `deep-rag` for long / multiple docs. |
| Standalone agent vs inline-in-flow | Same `resource.json` shape for both. The flow wiring differs — inline requires an edge from the agent's `tool` port to the tool node's `input` port. See [impl-json.md](impl-json.md). |

## Bindings / Permissions
Expand Down
Loading
Loading