chore: add more detail to contributing action guides #172
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🟡 Heimdall Review Status
|
0xRAG
force-pushed
the
chore/contributing-action
branch
2 times, most recently
from
29f3c51 to
49f050f
Compare
0xRAG
commented
Jan 28, 2025
.github/CONTRIBUTING-PYTHON.md
Outdated
| - For an example, see [test_mint_nft.py](https://github.com/coinbase/agentkit/blob/master/cdp-agentkit-core/python/tests/actions/test_mint_nft.py) | ||
| 1. **Prompt**: A description that helps the AI understand when and how to use the action. It's important to describe the inputs and outputs of the action and include examples. Additionally, think about what inputs can be removed entirely and fetched or inferred by the LLM, so that users don't have to manually provide them. | ||
| 2. **Input Schema**: Define the input parameters using [Pydantic](https://docs.pydantic.dev/latest/) schemas. Pydantic is used to validate the inputs to the action and to generate a JSON schema that can be used by the LLM to understand the inputs. | ||
| 3. **Implementation Function**: The actual logic that executes the action. This function receives as input the wallet that the Agent has access to, and as you'll see in the walkthrough below, we can use this wallet to invoke an onchain contract! |
There was a problem hiding this comment.
@murrlincoln do you think this is an appropriate place to add the link out to CDP docs, as mentioned here?
murrlincoln
reviewed
Jan 29, 2025
|
|
||
| * The prompt disambuguates the type of NFT by specifying "ERC-721" | ||
| * The prompt specifies that the destination address should not be the contract address | ||
| * The prompt specifies that the LLM should ask the user for the destination address if it is unsure |
There was a problem hiding this comment.
can we add that in the case where there is a contract address taken as a parameter, the code either specifies the addresses or in some other way indexes for them? want to avoid the situation with morpho, where a user was required to find and input the address for the vault they wanted
0xRAG
force-pushed
the
chore/contributing-action
branch
from
49f050f to
0115343
Compare
0xRAG
force-pushed
the
chore/contributing-action
branch
from
9aace78 to
bff92ca
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed? Why?
Closes the action items: