Skip to content

Commit 38f56df

Browse files
authored
Update README_template_for_partner.md
1 parent c39c459 commit 38f56df

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
1+
# <tool_name>
2+
<tool_name> will be used in Azure AI Foundry Portal experience and marketing materials.
13

4+
Requirement:
5+
- Must exist and be written in English.
6+
- Must be unique and distinguishable from any existing tool/agent template.
7+
- Should be the name of your product or organization.
8+
- Can't be longer than 30 characters.
9+
- Can't contain the words *API*, *Tool*, *Azure AI Agent Service*, *Azure AI*, *Agent*, or any of our other Azure AI Foundry product names (for example, Document Intelligence).
10+
- Can't end in a nonalphanumeric character, including carriage return, new line, or blank space.
11+
- Good example: Tripadvisor
12+
- Bad example: Tripadvisor Tool
13+
14+
## Description
15+
<tool_description>
16+
17+
<tool_descrption> will be used in Azure AI Foundry Portal experience and marketing materials.
18+
19+
Requirement:
20+
- Ensure your description complies with the [Marketplace guidelines](https://learn.microsoft.com/en-us/legal/marketplace/certification-policies#10013-description).
21+
- Must exist and be written in English.
22+
- Must be free of grammatical and spelling errors.
23+
- Length should be within 1 sentence, under 10 words
24+
- Cannot contain *Azure AI Agent Service* or other Azure AI Foundry product names (such as Document Intelligence)
25+
- If your tool includes multiple operations, the description should cover all operations.
26+
27+
## Prerequisites
28+
<prerequisites_in_bullet_points>
29+
30+
Requirement:
31+
- Must include how to create a new account with your service
32+
- Include any other requirements to set up the account, such as uploading data, etc
33+
- Recommend including screenshots if possible to help customers understand. Store the screenshots in `media` folder
34+
35+
## Setup
36+
<setup_in_bullet_points>
37+
38+
Requirement:
39+
- If you require customers to use `connection` as authentication methods, walk customers from step by step to retrieve the secret (API key, token etc) and how to create a `customKeys` connection to store the secret
40+
- Recommend including screenshots if possible to help customers understand. Store the screenshots in `media` folder
41+
42+
## Use <tool_name>
43+
<explanation_for_using_your_code_sample>
44+
45+
## Customer Support Contact
46+
<your_customer_support_contact_or_website>
47+
48+
By providing this customer support contact or website, customers will reach out to you directly if they run into issues with the OpenAPI spec, code sample, authentication etc. Customers will reach out to Microsoft if they run into issues with Azure AI Agent service.

0 commit comments

Comments
 (0)