Agent Card Starter

agent-card-starter

[tests] [license MIT] [python 3.9+]

Write and check the machine-readable card that makes a small business readable for AI assistants. Its WordPress sibling, Open Door for AI Assistants, goes one step further: an AI assistant will be able to leave an inquiry for the business, and the business gets it as an e-mail (inquiry service coming soon).

In 60 seconds: AI assistants read a small JSON file to learn what your business does. This tool writes that file for you and checks it. Offline, no account, no dependencies.

pip install agent-card-starteragent-card init --name "Muster Roofing Ltd" --description "Roofer in Musterstadt, repairs and new roofs." --website https://www.example.com --skill "Flat roof sealing"agent-card validate .well-known/agent-card.json --strict

Upload the file to https://<your-domain>/.well-known/agent-card.json and you are readable. Nothing here guarantees that an assistant will mention you.

In 60 Sekunden: KI-Assistenten lesen eine kleine Datei, um zu erfahren, was Ihr Betrieb macht. Dieses Werkzeug schreibt die Datei und prüft sie. Ohne Netz, ohne Konto, ohne Fremdpakete. Befehle siehe oben, die Datei kommt nach https://<Ihre-Domain>/.well-known/agent-card.json.

Starter kit to make a small business readable and reachable for AI assistants: an A2A agent card, an MCP server card, a minimal MCP example server and a validator. Standard library only, Python 3.9+, MIT licensed.

Starter-Set, damit ein kleiner Betrieb für KI-Assistenten lesbar und erreichbar wird: Agentenkarte (A2A), Server-Karte (MCP), ein minimaler MCP-Beispielserver und ein Prüfskript. Nur Python-Standardbibliothek, ab Python 3.9, MIT-Lizenz.

Maintained by flowboxx, an agency that builds AI doors for businesses. Gepflegt von flowboxx, einer Agentur, die KI-Türen für Betriebe baut.

English

What is in here

Quick start

agent-card init --name "Your Business" --description "What you do and where." --website https://www.example.comagent-card validate .well-known/agent-card.json --strict# from a clone, without installing:python3 tools/validate_agent_card.py examples/well-known/agent-card.jsonpython3 tools/validate_agent_card.py examples/mcp-server-card.json --strictprintf '{"jsonrpc":"2.0","id":1,"method":"tools/list"}\n' | python3 server/mcp_server.pypython3 -m pip install pytest && python3 -m pytest -qdocker build -t agent-card-starter . && docker run -i --rm agent-card-starter   # MCP over stdio

Use it for your business

1. Copy examples/well-known/agent-card.json, replace name, description, provider, skills.
2. List only services you really offer. One skill per service, stable ids.
3. Keep prices, phone numbers and promises out of the card. A human answers those.
4. Run the validator, publish the file at https://<your-domain>/.well-known/agent-card.json.
5. Point supportedInterfaces at an endpoint you really operate. The example server speaks MCP over stdio for learning. A public endpoint needs HTTP transport, rate limiting, spam protection and a privacy notice. anfrage_anlegen is a stub on purpose.

Notes on the standards

• The agent card follows the A2A v1.0 field names (supportedInterfaces, skills, provider).
• The server card follows the MCP Server Card proposal (SEP-2127). It is an extension and the schema may still change. Check the current schema before you publish.
• The validator checks required fields and a few sanity rules. It is not a full JSON Schema validation.
• Nothing here guarantees that an assistant will mention or recommend you.

Deutsch

Was drin ist

Schnellstart

agent-card init --name "Ihr Betrieb" --description "Was Sie tun und wo." --website https://www.example.comagent-card validate .well-known/agent-card.json --strict# aus einem Klon, ohne Installation:python3 tools/validate_agent_card.py examples/well-known/agent-card.jsonpython3 tools/validate_agent_card.py examples/mcp-server-card.json --strictprintf '{"jsonrpc":"2.0","id":1,"method":"tools/list"}\n' | python3 server/mcp_server.pypython3 -m pip install pytest && python3 -m pytest -qdocker build -t agent-card-starter . && docker run -i --rm agent-card-starter   # MCP over stdio

Für den eigenen Betrieb nutzen

1. examples/well-known/agent-card.json kopieren, Name, Beschreibung, Anbieter und Fähigkeiten ersetzen.
2. Nur Leistungen eintragen, die Sie wirklich anbieten. Eine Fähigkeit je Leistung, stabile Ids.
3. Keine Preise, Telefonnummern oder Zusagen in die Karte. Das beantwortet ein Mensch.
4. Prüfskript laufen lassen, Datei unter https://<Ihre-Domain>/.well-known/agent-card.json ablegen.
5. supportedInterfaces auf einen Endpunkt zeigen lassen, den Sie wirklich betreiben. Der Beispielserver spricht MCP über stdio zum Lernen. Ein öffentlicher Endpunkt braucht HTTP, Mengenbegrenzung, Spam-Schutz und einen Datenschutzhinweis. anfrage_anlegen ist absichtlich ein Stub und speichert nichts.

Hinweise zu den Standards

• Die Agentenkarte folgt den Feldnamen von A2A v1.0 (supportedInterfaces, skills, provider).
• Die Server-Karte folgt dem MCP-Vorschlag Server Card (SEP-2127). Das ist eine Erweiterung, das Schema kann sich noch ändern. Vor dem Veröffentlichen das aktuelle Schema prüfen.
• Das Prüfskript prüft Pflichtfelder und einige Plausibilitäten, keine vollständige JSON-Schema-Validierung.
• Nichts hier garantiert, dass ein Assistent Sie nennt oder empfiehlt.

Built with this? Tell us / Damit gebaut? Erzählen Sie es uns

If you published a card with this kit, show it in Discussions, Show and tell. We read every one. If you like, add the badge to your README:

Wenn Sie mit diesem Kit eine Karte veröffentlicht haben, zeigen Sie sie unter Discussions, Show and tell. Das Abzeichen für Ihre README:

[![built with agent-card-starter](https://img.shields.io/badge/built%20with-agent--card--starter-2b6cb0)](https://github.com/flowboxx/agent-card-starter)

As is / Ohne Gewähr

This is a starting point, provided "as is" under the MIT license, without warranty of any kind. Standards around agent cards and server cards are young and change. Check the current specifications before you publish. Nothing here is legal advice, and nothing guarantees that an assistant will mention or recommend your business. Changes are listed in CHANGELOG.md, how to help is in CONTRIBUTING.md.

Dies ist ein Ausgangspunkt, bereitgestellt "wie besehen" unter der MIT-Lizenz, ohne Gewähr. Die Standards rund um Agentenkarten und Server-Karten sind jung und ändern sich. Prüfen Sie vor dem Veröffentlichen die aktuellen Spezifikationen. Nichts hier ist Rechtsberatung, und nichts garantiert, dass ein Assistent Ihren Betrieb nennt oder empfiehlt. Änderungen stehen in CHANGELOG.md, Mitmachen steht in CONTRIBUTING.md.

MIT License, see LICENSE. Questions and contributions welcome via issues. Fragen und Beiträge gern als Issue.

Built and maintained by flowboxx, Germany.