Skip to content

Commit c39c459

Browse files
authored
Update and rename README_partner.md to PartnerContributingGuide.md
1 parent e742f13 commit c39c459

2 files changed

Lines changed: 38 additions & 1 deletion

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 3p Tool Partner Contributing Guide
2+
3+
## Who should read this?
4+
This contributing guide is designed for partners who want to bring their APIs as part of the **Azure AI Foundry Tool Catalog** so that customers can integrate your APIs with Azure AI Agent service through a tool to retrieve data or integrating with a workflow.
5+
6+
## Prepare your PR
7+
Your PR needs to create a new folder with the tool name and include the following information:
8+
- `README.md` (required): follow this [template](./README_template_for_parter.d) as an example and this README file will serve as public documentation for help customers set up and use the tool with your API through Azure AI Agent service
9+
- The name, logo, and description in this README file will be used in the Azure AI Foundry Portal user experience and marketing materials.
10+
- It must include how customers set up an account with your API directly and your customer support contact or website.
11+
- Customers should be able to follow this README file and successfully use the tool with Azure AI Agent service.
12+
- `sample code` (required): using at least one of the SDK below
13+
- (recommended) Python: [Azure AI Projects client library for Python | Microsoft Learn](https://learn.microsoft.com/en-us/python/api/overview/azure/ai-projects-readme?view=azure-python-preview#create-agent-with-openapi)
14+
- .NET/C#: [Azure AI Projects client library for .NET - Azure for .NET Developers | Microsoft Learn](https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.projects-readme?view=azure-dotnet-preview)
15+
- JavaScript: [Azure AI Projects client library for JavaScript | Microsoft Learn](https://learn.microsoft.com/en-us/javascript/api/overview/azure/ai-projects-readme?view=azure-node-preview)
16+
- Requirements fot the code sample:
17+
- you should have tested the code sample works end to end with the OpenAPI spec in this PR before submitting
18+
- include the process of creating an `openApi` tool with your OpenAPI spec
19+
- for `agent creation`, provide a user-friendly name and useful instructions customized for your API
20+
- for `message creation`, provide an example of a user query that can be used with your API and expected response in comments
21+
- `OpenAPI spec` (required): the OpenAPI spec for your API
22+
- Your OpenAPI should be updated based on the requirements [here](https://learn.microsoft.com/en-us/azure/ai-services/agents/how-to/tools/openapi-spec?tabs=python&pivots=overview#authenticating-with-api-key) to support appropriate authentication method
23+
- If you require customers to update the OpenAPI spec, please provide **clear** instructions and **placeholder** on where they should update in the OpenAPI spec file and the README.file.
24+
- This OpenAPI spec will also be used in the Azure AI Foundry Portal user experience.
25+
- `media` folder (optional): if you need to include any screenshots, please add the screenshots in this folder and refer to them.
26+
27+
## Submit your PR
28+
Before you submit the PR, please double check:
29+
- you have **everything** required above ready
30+
- you have **fully** tested your code sample
31+
32+
Then, you can go ahead and create a PR. By creating a PR, you automatically agree to the Contributor License Agreement and see more details [here](../../CONTRIBUTING.md).
33+
34+
When creating the PR, please make sure you give your PR a reviewer-friendly name. We will come back to you within 10 business days.
35+
36+
## Once your PR is approved
37+
- customers will see a folder for the tool in `main` branch
38+
- Azure AI Foundry Portal team will work to bring your tool to the Portal user experience.

use-cases/agents/3p-tool/README_partner.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)