Skip to content

fix: formatting issues, add txn passing instructions to semi-autonomous flow#5

Merged
Philippoes merged 5 commits intomainfrom
eng-2055
Apr 3, 2026
Merged

fix: formatting issues, add txn passing instructions to semi-autonomous flow#5
Philippoes merged 5 commits intomainfrom
eng-2055

Conversation

@Ishita-02
Copy link
Copy Markdown
Collaborator

@Ishita-02 Ishita-02 commented Apr 2, 2026

Summary by CodeRabbit

  • Documentation
    • Updated MCP registration name to yield-agentkit
    • Enhanced onboarding with explicit Privy wallet setup and optional policy guidance
    • Removed transaction-hash submission step; flows stop at balance confirmation
    • Clarified transaction construction (include value, omit nulls) and nonce adjustment for multi-step flows
    • Expanded Privy policy templates with explicit rule objects; updated example links/paths
    • Adjusted tool docs (optional yieldIds filter, action param shapes, uppercase types) and removed Cosmos chain mentions; example renumbering and diagram network label updated to BNB

@Ishita-02 Ishita-02 requested a review from Philippoes April 2, 2026 11:58
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 2, 2026

📝 Walkthrough

Walkthrough

Documentation-only updates across the yield-agentkit-privy skill: MCP name changed to yield-agentkit, {baseDir} prefixes removed from reference paths, new wallet setup step added, policy examples expanded to full rule objects, Cosmos removed from chain_type, and transaction guidance updated (null-value filtering + nonce offsets).

Changes

Cohort / File(s) Summary
MCP Registration & Readme
yield-agentkit-skills/skills/yield-agentkit-privy/README.md
Rename MCP example from yield-xyzyield-agentkit; remove final step that submitted a transaction hash back to yield.xyz in the combined-flow walkthrough.
Skill Doc & Onboarding
yield-agentkit-skills/skills/yield-agentkit-privy/SKILL.md
Remove {baseDir} prefixes from reference links; add "Step 2 — Set Up Wallet" documenting List Wallets, storing PRIVY_WALLET_ID, optional PRIVY_POLICY_ID, and new-wallet creation flow.
References — Paths & Examples
yield-agentkit-skills/skills/yield-agentkit-privy/references/...
architecture.md, examples.md, semi-autonomous.md, yield-mcp-tools.md
Normalized reference paths (removed {baseDir}), updated example numbering (removed one staking example), adjusted semi-autonomous wording, and updated yields/tool parameter docs (e.g., balances filter change).
Privy Policies
yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-policies.md
Replace shorthand rules: [...] snippets with fully structured Privy policy rule objects (named rules, method, conditions, action) across templates; update one reference path.
Privy Transactions & Wallets
yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-transactions.md, .../privy-wallets.md
EVM transaction examples now include value and instruct filtering out null fields when deriving PRIVY_TX; add nonce offset handling for multi-transaction flows; remove cosmos from chain_type table.
Examples Reorganization
yield-agentkit-skills/skills/yield-agentkit-privy/references/examples.md
Delete "Staking with Validator Selection" example, renumber subsequent examples, and trim trailing submit-to-yield.xyz clause in the semi-autonomous onboarding example.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • Philippoes

Poem

🐰 I hopped through docs, a tidy little feat,
Paths shortened neatly, wallet steps complete,
BNB whispers where Cosmos once stood,
Rules spelled out clear, transactions trimmed good,
Hooray — yield-agentkit hops on, neat and sweet!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: fixing formatting issues and adding transaction passing instructions to the semi-autonomous workflow, which are reflected across the documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch eng-2055

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/architecture.md`:
- Line 37: Update the privy-wallets.md documentation so the ethereum chain_type
example explicitly lists BNB Chain (and optionally Avalanche) alongside the
other EVM chains; locate the ethereum entry in the privy-wallets.md table (the
chain_type column / "ethereum" row) and expand its example text from "All EVM
chains — Ethereum, Base, Arbitrum, Optimism, Polygon, etc." to include "BNB
Chain" (and "Avalanche" if desired) to match references in
privy-transactions.md, privy-policies.md, and the README.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2881d475-4ff4-428f-92b6-590fffd7f312

📥 Commits

Reviewing files that changed from the base of the PR and between 525a3bf and 7d08d07.

📒 Files selected for processing (9)
  • yield-agentkit-skills/skills/yield-agentkit-privy/README.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/SKILL.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/architecture.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/examples.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-policies.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-transactions.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-wallets.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/semi-autonomous.md
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md
💤 Files with no reviewable changes (1)
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/privy-wallets.md

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md (1)

92-106: ⚠️ Potential issue | 🟠 Major

Update schema field guidance to match new parameter interface.

Lines 92-106 describe the mechanics.arguments.enter schema fields and state that field names should be "included in arguments_json" (line 96). However, the updated actions_enter interface (lines 180-181) no longer uses an arguments_json parameter—it now uses explicit amount and optional args parameters.

Update this section to clarify how schema fields map to the new interface (e.g., required fields like validatorAddress or inputToken should be passed in the args object).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`
around lines 92 - 106, Update the schema docs for mechanics.arguments.enter
(ArgumentFieldDto) to map fields to the new actions_enter parameter interface:
replace references to including field names in arguments_json with guidance that
scalar fields (like validatorAddress, inputToken, etc.) should be provided
inside the actions_enter args object and that amount remains a separate
top-level parameter; keep the note that if optionsRef is present (e.g.,
validatorAddress) the client must call yields_get_validators to fetch valid
options before invoking actions_enter.
🧹 Nitpick comments (1)
yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md (1)

180-181: Clarify when args fields are required.

The args parameter documentation states it "May include validatorAddress (string), inputToken (string)," which suggests these are always optional. However, based on the schema inspection guidance (lines 92-105), some fields may be required depending on the yield's schema.

Consider adding a note that references the schema inspection section, e.g., "See lines 92-105 for determining which fields are required based on the yield's enter schema."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`
around lines 180 - 181, Update the docs for the `args` field in the table row
that lists `args` (and mentions `validatorAddress` and `inputToken`) to clarify
that some `args` properties can be required depending on the yield's enter
schema; reference the schema inspection guidance (lines 92-105) so readers know
to consult that section to determine required vs optional fields.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`:
- Line 120: The table currently lists the parameter `yieldId` as type `string[]`
but the API path `POST /v1/yields/{yieldId}/balances` and examples use a single
identifier; change the parameter type for `yieldId` from `string[]` to `string`
and update the description to "Unique yield identifier" to match usage (or, if
multiple IDs are intended, instead clarify the description and update the
endpoint/examples accordingly); ensure the `yieldId` entry in the parameters
table and any examples consistently reflect the chosen single-string type.

---

Outside diff comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`:
- Around line 92-106: Update the schema docs for mechanics.arguments.enter
(ArgumentFieldDto) to map fields to the new actions_enter parameter interface:
replace references to including field names in arguments_json with guidance that
scalar fields (like validatorAddress, inputToken, etc.) should be provided
inside the actions_enter args object and that amount remains a separate
top-level parameter; keep the note that if optionsRef is present (e.g.,
validatorAddress) the client must call yields_get_validators to fetch valid
options before invoking actions_enter.

---

Nitpick comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`:
- Around line 180-181: Update the docs for the `args` field in the table row
that lists `args` (and mentions `validatorAddress` and `inputToken`) to clarify
that some `args` properties can be required depending on the yield's enter
schema; reference the schema inspection guidance (lines 92-105) so readers know
to consult that section to determine required vs optional fields.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d1a2d915-3a6f-4bb4-9425-43b10253e72e

📥 Commits

Reviewing files that changed from the base of the PR and between 7d08d07 and c7fd39f.

📒 Files selected for processing (1)
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md

Comment thread yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md (1)

180-181: Clarify when args fields are required and verify API compatibility.

The args parameter documentation states "May include validatorAddress (string), inputToken (string)" but doesn't specify when these fields are needed. Consider adding guidance such as:

  • validatorAddress: Required when the yield's enter schema indicates validator selection (check yields_get for fields with optionsRef)
  • inputToken: Required when the yield accepts multiple input tokens

Additionally, since this represents a significant API change from the previous arguments_json approach (per the AI summary), verify that the MCP tool actually accepts this parameter structure.

#!/bin/bash
# Description: Verify the actions_enter parameter structure is documented consistently

# Check for any OpenAPI/JSON schema definitions
fd -e json -e yaml | xargs rg -l 'actions.*enter|enter.*action' | head -5 | xargs cat

# Search for examples or usage of args parameter in actions_enter
rg -n --type=md 'actions_enter' -A10 -B2 | rg -C5 'args|validatorAddress|inputToken'
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`
around lines 180 - 181, The docs for the `args` parameter are ambiguous about
when `validatorAddress` and `inputToken` are required and may not match the MCP
tool's expected structure (replacing `arguments_json`); update the `args` row to
explicitly state requirement conditions (e.g., "validatorAddress: required when
the yield's enter schema indicates validator selection (see yields_get for
fields with optionsRef)"; "inputToken: required when the yield accepts multiple
input tokens") and add a short note that callers must pass `args` as an object
in the actions_enter payload (verify compatibility with MCP by testing that
actions_enter accepts the new `args` object format rather than the old
`arguments_json`). Also run the suggested verification commands to confirm
OpenAPI/JSON schemas and example usage align with this `args` shape and adjust
the docs to match the actual MCP expectations.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`:
- Around line 206-209: The table in the actions_exit parameter docs incorrectly
marks validatorAddress and passthrough as simply "No"; update the "Required"
column for `validatorAddress` and `passthrough` to indicate conditional
requirement (e.g., "Conditional" or "Conditional*") and add a short footnote
explaining the condition: `validatorAddress` is required when the yield uses
validator selection and `passthrough` is required when the exit schema includes
it (reference how to check via `yields_get`); ensure the change mentions
`actions_exit`, `validatorAddress`, `passthrough`, and `yields_get` so readers
know where to check the schema.
- Line 189: Align transaction type casing between the docs by making the example
values match the canonical form in yield-mcp-tools.md: check the actual API
behavior and then update architecture.md so its example uses uppercase type
strings ("APPROVAL", "STAKE", "SUPPLY") instead of "approval"/"deposit" (replace
"deposit" with "SUPPLY" if that maps to the same API action), and update any
other examples that use lowercase types to the documented uppercase variants;
search for occurrences of "type": "approval", "type": "deposit", etc., and
normalize them to the canonical tokens or update yield-mcp-tools.md if the API
truly uses lowercase.

---

Nitpick comments:
In
`@yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md`:
- Around line 180-181: The docs for the `args` parameter are ambiguous about
when `validatorAddress` and `inputToken` are required and may not match the MCP
tool's expected structure (replacing `arguments_json`); update the `args` row to
explicitly state requirement conditions (e.g., "validatorAddress: required when
the yield's enter schema indicates validator selection (see yields_get for
fields with optionsRef)"; "inputToken: required when the yield accepts multiple
input tokens") and add a short note that callers must pass `args` as an object
in the actions_enter payload (verify compatibility with MCP by testing that
actions_enter accepts the new `args` object format rather than the old
`arguments_json`). Also run the suggested verification commands to confirm
OpenAPI/JSON schemas and example usage align with this `args` shape and adjust
the docs to match the actual MCP expectations.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 331dd232-e142-42c6-bd31-6369afeda561

📥 Commits

Reviewing files that changed from the base of the PR and between c7fd39f and 88dc319.

📒 Files selected for processing (1)
  • yield-agentkit-skills/skills/yield-agentkit-privy/references/yield-mcp-tools.md

@Philippoes Philippoes merged commit 76381bc into main Apr 3, 2026
3 checks passed
This was referenced Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants