Tiny agents custom endpoint (#1470)

Author: julien-c

packages/tiny-agents/README.md

@@ -16,7 +16,6 @@ pnpm add @huggingface/tiny-agents
 
 ```bash
 npx @huggingface/tiny-agents [command] "agent/id"
-
 ```
 
 ```
@@ -41,8 +40,8 @@ touch my-agent/agent.json
 
 ```json
 {
-	"model": "Qwen/Qwen2.5-72B-Instruct", // model id
-	"provider": "nebius", // or you can also use a local endpoint base url with `endpointUrl`
+	"model": "Qwen/Qwen2.5-72B-Instruct",
+	"provider": "nebius",
 	"servers": [
 		{
 			"type": "stdio",
@@ -55,6 +54,25 @@ touch my-agent/agent.json
 }
 ```
 
+Or using a local or remote endpoint URL:
+
+```json
+{
+	"model": "Qwen/Qwen3-32B",
+	"endpointUrl": "http://localhost:1234/v1",
+	"servers": [
+		{
+			"type": "stdio",
+			"config": {
+				"command": "npx",
+				"args": ["@playwright/mcp@latest"]
+			}
+		}
+	]
+}
+
+```
+
 Where `servers` is a list of MCP servers (we support Stdio, SSE, and HTTP servers).
 
 Optionally, you can add a `PROMPT.md` file to override the default Agent prompt.

packages/tiny-agents/src/cli.ts

@@ -114,11 +114,17 @@ async function main() {
 
 	const { configJson, prompt } = await loadConfigFrom(loadFrom);
 
-	const ConfigSchema = z.object({
-		model: z.string(),
-		provider: z.enum(PROVIDERS_OR_POLICIES),
-		servers: z.array(ServerConfigSchema),
-	});
+	const ConfigSchema = z
+		.object({
+			model: z.string(),
+			provider: z.enum(PROVIDERS_OR_POLICIES).optional(),
+			endpointUrl: z.string().optional(),
+			apiKey: z.string().optional(),
+			servers: z.array(ServerConfigSchema),
+		})
+		.refine((data) => data.provider !== undefined || data.endpointUrl !== undefined, {
+			message: "At least one of 'provider' or 'endpointUrl' is required",
+		});
 
 	let config: z.infer<typeof ConfigSchema>;
 	try {
@@ -129,13 +135,24 @@ async function main() {
 		process.exit(1);
 	}
 
-	const agent = new Agent({
-		provider: config.provider,
-		model: config.model,
-		apiKey: process.env.HF_TOKEN ?? "",
-		servers: config.servers,
-		prompt,
-	});
+	const agent = new Agent(
+		config.endpointUrl
+			? {
+					endpointUrl: config.endpointUrl,
+					model: config.model,
+					apiKey: config.apiKey ?? process.env.API_KEY ?? process.env.HF_TOKEN,
+					servers: config.servers,
+					prompt,
+			  }
+			: {
+					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+					provider: config.provider!,
+					model: config.model,
+					apiKey: config.apiKey ?? process.env.API_KEY ?? process.env.HF_TOKEN,
+					servers: config.servers,
+					prompt,
+			  }
+	);
 
 	if (command === "serve") {
 		error(`Serve is not implemented yet, coming soon!`);