diff --git a/packages/tiny-agents/README.md b/packages/tiny-agents/README.md index df60201c23..6d50e9a008 100644 --- a/packages/tiny-agents/README.md +++ b/packages/tiny-agents/README.md @@ -73,7 +73,7 @@ Or using a local or remote endpoint URL: 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. +Optionally, you can add an [`AGENTS.md`](https://agents.md/) (or `PROMPT.md`) file to override the default Agent prompt. Then just point tiny-agents to your local folder: @@ -93,7 +93,7 @@ npx @huggingface/tiny-agents run "julien-c/flux-schnell-generator" ``` > [!NOTE] -> Want to share your own agent with the community? Submit a PR to the [Tiny Agents](https://huggingface.co/datasets/tiny-agents/tiny-agents/discussions) repository on the Hub. Your submission must include an `agent.json` file, and you can optionally add a `PROMPT.md` file. To help others understand your agent's capabilities, consider including an `EXAMPLES.md` file with sample prompts and use cases. +> Want to share your own agent with the community? Submit a PR to the [Tiny Agents](https://huggingface.co/datasets/tiny-agents/tiny-agents/discussions) repository on the Hub. Your submission must include an `agent.json` file, and you can optionally add a `PROMPT.md` or [`AGENTS.md`](https://agents.md/) file. To help others understand your agent's capabilities, consider including an `EXAMPLES.md` file with sample prompts and use cases. ## Advanced: Programmatic Usage diff --git a/packages/tiny-agents/src/lib/loadConfigFrom.ts b/packages/tiny-agents/src/lib/loadConfigFrom.ts index 7396f110df..365c7444af 100644 --- a/packages/tiny-agents/src/lib/loadConfigFrom.ts +++ b/packages/tiny-agents/src/lib/loadConfigFrom.ts @@ -6,7 +6,7 @@ import type { TinyAgentConfig } from "./types"; import { debug, error } from "./utils"; const FILENAME_CONFIG = "agent.json"; -const FILENAME_PROMPT = "PROMPT.md"; +const PROMPT_FILENAMES = ["AGENTS.md", "PROMPT.md"] as const; const TINY_AGENTS_HUB_REPO: RepoDesignation = { name: "tiny-agents/tiny-agents", @@ -29,10 +29,18 @@ async function tryLoadFromDirectory(dirPath: string): Promise