-
Notifications
You must be signed in to change notification settings - Fork 137
docs: split development / stable #1709
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| { | ||
| "python.terminal.activateEnvironment": false | ||
| "python.terminal.activateEnvironment": false, | ||
| "debug.javascript.defaultRuntimeExecutable": { | ||
| "pwa-node": "/Users/jp/.local/share/mise/shims/node" | ||
| } | ||
| } |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Mintlify Starter Kit | ||
|
|
||
| Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including | ||
|
|
||
| - Guide pages | ||
| - Navigation | ||
| - Customizations | ||
| - API Reference pages | ||
| - Use of popular components | ||
|
|
||
| ### Development | ||
|
|
||
| Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command | ||
|
|
||
| ``` | ||
| npm i -g mintlify | ||
| ``` | ||
|
|
||
| Run the following command at the root of your documentation (where docs.json is) | ||
|
|
||
| ``` | ||
| mintlify dev | ||
| ``` | ||
|
|
||
| ### Publishing Changes | ||
|
|
||
| Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. | ||
|
|
||
| #### Troubleshooting | ||
|
|
||
| - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. | ||
| - Page loads as a 404 - Make sure you are running in a folder with `docs.json` |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: "Customize Agent Details" | ||
| description: "Configure how your agent appears and behaves in the GUI" | ||
| --- | ||
|
|
||
| When building your agent, you can configure certain attributes that affect how it appears and behaves in the user interface. The `@server.agent` decorator accepts a `detail` parameter with an `AgentDetail` object that controls the visual representation and behavior in the UI. | ||
|
|
||
| You can customize various aspects of your agent's presentation, such as: | ||
| - The type of user interface the agent uses (chat, form, etc.) | ||
| - Custom user greetings | ||
| - Metadata about tools the agent provides | ||
| - Author and contributor information | ||
| - License, framework, and source code details | ||
|
|
||
| ## Basic Configuration | ||
|
|
||
| Configuring agent details is straightforward. Import `AgentDetail` and related types, then pass them to the `detail` parameter in the `@server.agent` decorator: | ||
| ```python | ||
| import os | ||
| from textwrap import dedent | ||
|
|
||
| from a2a.types import AgentSkill, Message | ||
| from agentstack_sdk.server import Server | ||
| from agentstack_sdk.server.context import RunContext | ||
| from agentstack_sdk.a2a.extensions import AgentDetail, AgentDetailContributor, AgentDetailTool | ||
|
|
||
| server = Server() | ||
|
|
||
| @server.agent( | ||
| name="Example Research Assistant", | ||
| detail=AgentDetail( | ||
| interaction_mode="multi-turn", # or single-turn | ||
| user_greeting="Hi there! I can help you research topics or summarize uploaded documents.", | ||
| tools=[ | ||
| AgentDetailTool( | ||
| name="Web Search", | ||
| description="Looks up recent and relevant information from the web." | ||
| ), | ||
| AgentDetailTool( | ||
| name="Document Reader", | ||
| description="Reads and extracts key insights from uploaded PDFs or text files." | ||
| ), | ||
| ], | ||
| framework="BeeAI Framework", | ||
| author=AgentDetailContributor( | ||
| name="Agent Stack Team", | ||
| email="[email protected]", | ||
| ), | ||
| source_code_url="https://github.com/example/example-research-assistant", | ||
| ), | ||
| skills=[ | ||
| AgentSkill( | ||
| id="research", | ||
| name="Research", | ||
| description=dedent( | ||
| """\ | ||
| Finds up-to-date information on a given topic, synthesizes key points, | ||
| and summarizes findings in clear, useful responses. | ||
| """ | ||
| ), | ||
| tags=["Search", "Knowledge"], | ||
| examples=[ | ||
| "Find recent news about AI ethics in 2025.", | ||
| "What are the main challenges in renewable energy adoption?", | ||
| "Give me an overview of current space exploration missions.", | ||
| ], | ||
| ), | ||
| AgentSkill( | ||
| id="summarization", | ||
| name="Summarization", | ||
| description=dedent( | ||
| """\ | ||
| Reads and summarizes uploaded text or documents, highlighting the | ||
| most important ideas, statistics, and conclusions. | ||
| """ | ||
| ), | ||
| tags=["Documents", "Summaries"], | ||
| examples=[ | ||
| "Summarize this PDF report about electric vehicle trends.", | ||
| "What are the main points from this research article?", | ||
| "Condense this document into a short summary I can share.", | ||
| ], | ||
| ), | ||
| ], | ||
| ) | ||
| async def example_agent(input: Message, context: RunContext): | ||
| """An example agent with detailed configuration""" | ||
| yield "Hello World!" | ||
|
|
||
| def run(): | ||
| server.run(host=os.getenv("HOST", "127.0.0.1"), port=int(os.getenv("PORT", 8000))) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| run() | ||
| ``` | ||
|
|
||
| ## Key Fields | ||
|
|
||
| ### UI Configuration | ||
| - **`interaction_mode`**: Set to `"multi-turn"` for conversational agents or `"single-turn"` for one-shot agents | ||
| - **`user_greeting`**: Welcome message displayed when users first interact with your agent | ||
|
|
||
| ### Metadata | ||
| - **`framework`**: The framework used to build your agent (e.g., "BeeAI", "LangGraph", "CrewAI") | ||
| - **`programming_language`**: Primary language (e.g., "Python", "JavaScript") | ||
| - **`license`**: Software license (e.g., "Apache 2.0", "MIT") | ||
|
|
||
| ### Tools | ||
| - **`tools`**: List of `AgentDetailTool` objects describing your agent's capabilities | ||
| - Each tool has a `name` and `description` to help users understand each tool's purpose | ||
|
|
||
| ### Skills | ||
| - **`skills`**: List of `AgentSkill` objects that represent distinct, user-facing abilities your agent can perform | ||
| - Each skill includes an id, name, description, tags, and examples | ||
| - Examples are displayed in the user interface as starter questions — they help users understand what kinds of requests your agent can handle and encourage exploration | ||
| - Skills define what your agent can do — for example, “Research” for finding and summarizing information, or “Summarization” for condensing long documents | ||
|
|
||
| ### Links and Attribution | ||
| - **`source_code_url`**: Link to the source code repository | ||
| - **`author`**: Primary author information (name, email, url) | ||
| - **`contributors`**: List of additional contributors | ||
|
|
||
| <Tip> | ||
| The Agent Details extension helps users understand your agent's capabilities before they start using it. Provide clear descriptions and accurate tool information to improve the user experience. | ||
| </Tip> |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.