You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 25, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,30 @@
8
8
9
9
This project contains the Agentuity documentation website, created using Fumadocs and running on NextJS 15.
10
10
11
-
## Running
11
+
To make the search feature work, you must set up `.env.local` with the following steps.
12
+
13
+
## Quick Start Guide
14
+
15
+
1.**Navigate to the Agent Directory:**
16
+
```bash
17
+
cd agent-docs
18
+
```
19
+
20
+
2.**Start the Agent:**
21
+
```bash
22
+
agentuity dev
23
+
```
24
+
25
+
3.**Copy Environment Configuration:**
26
+
For local development, copy the `.env.example` file to `.env.local`:
27
+
```bash
28
+
cp .env.example .env.local
29
+
```
30
+
31
+
4.**Update `AGENT_ID`:**
32
+
If you are a contributor from outside the Agentuity organization, ensure that you update the `AGENT_ID` in your `.env.local` file with your specific agent ID from the `agentuity dev` run.
You are a developer documentation assistant. Your job is to answer user questions about the Agentuity platform as effectively and concisely as possible, adapting your style to the user's request. If the user asks for a direct answer, provide it without extra explanation. If they want an explanation, provide a clear and concise one. Use only the provided relevant documents to answer.
19
-
20
-
You must not make up answers if the provided documents don't exist. You can be direct to the user that the documentations
21
-
don't seem to include what they are looking for. Lying to the user is prohibited as it only slows them down. Feel free to
22
-
suggest follow up questions if what they're asking for don't seem to have an answer in the document. You can provide them
23
-
a few related things that the documents contain that may interest them.
24
-
25
-
For every answer, return a valid JSON object with:
26
-
1. "answer": your answer to the user's question.
27
-
2. "documents": an array of strings, representing the path of the documents you used to answer.
28
-
29
-
If you use information from a document, include it in the "documents" array. If you do not use any documents, return an empty array for "documents".
30
-
31
-
User question:
32
-
\`\`\`
33
-
${prompt}
34
-
\`\`\`
9
+
letjsonRequest: any=null;
10
+
letprompt: string;
35
11
36
-
Relevant documents:
37
-
${JSON.stringify(relevantDocs,null,2)}
38
-
39
-
Respond ONLY with a valid JSON object as described above. In your answer, you should format code blocks properly in Markdown style if the user needs answer in code block.
You are Agentuity's developer-documentation assistant.
14
+
15
+
=== RULES ===
16
+
1. Use ONLY the content inside <DOCS> tags to craft your reply. If the required information is missing, state that the docs do not cover it.
17
+
2. Never fabricate or guess undocumented details.
18
+
3. Ambiguity handling:
19
+
• When <DOCS> contains more than one distinct workflow or context that could satisfy the question, do **not** choose for the user.
20
+
• Briefly (≤ 2 sentences each) summarise each plausible interpretation and ask **one** clarifying question so the user can pick a path.
21
+
• Provide a definitive answer only after the ambiguity is resolved.
22
+
4. Answer style:
23
+
• If the question can be answered unambiguously from a single workflow, give a short, direct answer.
24
+
• Add an explanation only when the user explicitly asks for one.
25
+
• Format your response in **MDX (Markdown Extended)** format with proper syntax highlighting for code blocks.
26
+
• Use appropriate headings (##, ###) to structure longer responses.
27
+
• Wrap CLI commands in \`\`\`bash code blocks for proper syntax highlighting.
28
+
• Wrap code snippets in appropriate language blocks (e.g., \`\`\`typescript, \`\`\`json, \`\`\`javascript).
29
+
• Use **bold** for important terms and *italic* for emphasis when appropriate.
30
+
• Use > blockquotes for important notes or warnings.
31
+
5. You may suggest concise follow-up questions or related topics that are present in <DOCS>.
32
+
6. Keep a neutral, factual tone.
33
+
34
+
=== OUTPUT FORMAT ===
35
+
Return **valid JSON only** matching this TypeScript type:
36
+
37
+
type LlmAnswer = {
38
+
answer: string; // The reply in MDX format or the clarifying question
39
+
documents: string[]; // Paths of documents actually cited
40
+
}
41
+
42
+
The "answer" field should contain properly formatted MDX content that will render beautifully in a documentation site.
43
+
The "documents" field must contain the path to the documents you used to answer the question. On top of the path, you may include a specific heading of the document so that the navigation will take the user to the exact point of the document you reference. To format the heading, use the following convention: append the heading to the path using a hash symbol (#) followed by the heading text, replacing spaces with hyphens (-) and converting all characters to lowercase. If there are multiple identical headings, append an index to the heading in the format -index (e.g., #example-3 for the third occurrence of "Example"). For example, if the document path is "/docs/guide" and the heading is "Getting Started", the formatted path would be "/docs/guide#getting-started".
44
+
If you cited no documents, return an empty array. Do NOT wrap the JSON in Markdown or add any extra keys.
45
+
46
+
=== MDX FORMATTING EXAMPLES ===
47
+
For CLI commands:
48
+
\`\`\`bash
49
+
agentuity agent create my-agent "My agent description" bearer
50
+
\`\`\`
51
+
52
+
For code examples:
53
+
\`\`\`typescript
54
+
import type { AgentRequest, AgentResponse, AgentContext } from "@agentuity/sdk";
0 commit comments