Markdown in Descriptions

How to format your agent description with Markdown — supported syntax, examples, and what's not allowed.

Written By pvdyck

Last updated 7 days ago

Formatting Your Description with Markdown

Your agent description supports Markdown, a simple formatting language that lets you create rich, readable descriptions. Here's everything you can use.

Text Formatting

What you typeWhat it looks like
**bold text**bold text
*italic text*italic text
~~strikethrough~~strikethrough
`inline code`inline code

Headings

## Section Title### Subsection#### Smaller Heading

Use headings to organize longer descriptions into clear sections.

Links

[Visit our docs](https://help.indie.money)

All links open in a new tab automatically.

Lists

Bullet list:

- First item- Second item- Third item

Numbered list:

1. Step one2. Step two3. Step three

Code Blocks

For multi-line code or examples, wrap with triple backticks:

```{  "input": "your data here",  "format": "json"}```

Blockquotes

> This is a callout or important note.

This is a callout or important note.

Tables

| Column A | Column B | Column C ||----------|----------|----------|| Value 1  | Value 2  | Value 3  || Value 4  | Value 5  | Value 6  |

Tables are great for listing parameters, pricing tiers, or input/output formats.

Images

![Description of image](https://example.com/image.png)

Images are displayed at a maximum width that fits the description area. Use images to show workflow diagrams, example outputs, or screenshots.

Horizontal Rules

---

Use a horizontal rule to visually separate sections.

What's Not Supported

For security reasons, the following are not rendered in descriptions:

  • Embedded videos or audio
  • Iframes or embedded pages
  • Custom HTML or CSS
  • JavaScript

Tips for Great Descriptions

  • Lead with what it does — Start with a one-sentence summary of what your agent accomplishes.
  • List the inputs — What does the user need to provide? Use a table or bullet list.
  • Show example output — Use a code block to show what the agent returns.
  • Keep it scannable — Use headings and short paragraphs. Walls of text get skipped.

Related