Skip to content

Commit 1d9ed47

Browse files
committed
split out MCP guides
1 parent e0850bc commit 1d9ed47

17 files changed

Lines changed: 1327 additions & 287 deletions

File tree

‎_includes/mcp_tools.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Available tools
2+
3+
HTML/CSS to Image (HCTI) exposes the same MCP tools in every supported client. Ask your assistant to use HCTI by name when you want it to render HTML/CSS or capture a website.
4+
5+
### Account usage
6+
7+
| Tool | What it does |
8+
|:-----|:------------|
9+
| **check_usage** | Check images used, the account's image allowance, the next reset date, and whether overages are enabled. Does not render an image. |
10+
11+
### Screenshots and rendering
12+
13+
| Tool | What it does |
14+
|:-----|:------------|
15+
| **create_image** | Render HTML and CSS as PNG, JPG, WebP, or PDF. Accepts rendering options such as `device_scale`, `viewport_width`, `viewport_height`, and `ms_delay`. |
16+
| **create_url_image** | Capture a public webpage or a specific element using a CSS selector. Supports viewport settings and cookie banner blocking. |
17+
| **create_templated_image** | Render a saved template using its `template_id` and a `template_values` object. |
18+
| **create_batch_images** | Render multiple variations in one request, with shared `default_options` and per-image `variations`. |
19+
| **get_max_batch_size** | Check the authorized account's current batch limit before preparing a batch. |
20+
21+
### Template management
22+
23+
| Tool | What it does |
24+
|:-----|:------------|
25+
| **create_template** | Save HTML and CSS as a reusable template with variables. |
26+
| **update_template** | Update an existing template by ID. |
27+
| **list_templates** | Find templates in the connected HCTI account. |
28+
| **list_template_versions** | Inspect the version history of a template. |
29+
30+
See the [rendering parameters](/integrations/mcp/#image-parameters) for available options and the [Template Editor guide](/template-editor/) for designing reusable templates.

‎_includes/nav.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<li class="nav-list-item {% if node.expanded or page.url == node.url or page.parent == node.title or page.grand_parent == node.title or page.great_grand_parent == node.title %} active{% endif %}">
1717
{%- if page.parent == node.title or page.grand_parent == node.title or page.great_grand_parent == node.title -%}
1818
{%- assign first_level_url = node.url | absolute_url -%}
19+
{%- assign first_level_title = node_nav_title -%}
1920
{%- endif -%}
2021
{%- if node.has_children -%}
2122
{%- if node.expanded != true -%}
@@ -34,6 +35,7 @@
3435
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title or page.grand_parent == child.title %} active{% endif %}">
3536
{%- if page.url == child.url or page.parent == child.title or page.grand_parent == child.title -%}
3637
{%- assign second_level_url = child.url | absolute_url -%}
38+
{%- assign second_level_title = child_nav_title -%}
3739
{%- endif -%}
3840
{%- if child.has_children -%}
3941
<a href="#" class="nav-list-expander" aria-label="Expand {{ child_nav_title }}"><svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg></a>
@@ -47,6 +49,7 @@
4749
<li class="nav-list-item {% if page.url == grand_child.url or page.parent == grand_child.title %} active{% endif %}">
4850
{%- if page.url == grand_child.url or page.parent == grand_child.title -%}
4951
{%- assign third_level_url = grand_child.url | absolute_url -%}
52+
{%- assign third_level_title = grand_child_nav_title -%}
5053
{%- endif -%}
5154
{%- if grand_child.has_children -%}
5255
<a href="#" class="nav-list-expander" aria-label="Expand {{ grand_child_nav_title }}"><svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg></a>

‎_layouts/default.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@
8686
<nav aria-label="Breadcrumb" class="breadcrumb-nav">
8787
<ol class="breadcrumb-nav-list">
8888
{% if page.great_grand_parent %}
89-
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.great_grand_parent }}</a></li>
90-
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.grand_parent }}</a></li>
91-
<li class="breadcrumb-nav-list-item"><a href="{{ third_level_url }}">{{ page.parent }}</a></li>
89+
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ first_level_title | default: page.great_grand_parent }}</a></li>
90+
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ second_level_title | default: page.grand_parent }}</a></li>
91+
<li class="breadcrumb-nav-list-item"><a href="{{ third_level_url }}">{{ third_level_title | default: page.parent }}</a></li>
9292
{% elsif page.grand_parent %}
93-
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
94-
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
93+
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ first_level_title | default: page.grand_parent }}</a></li>
94+
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ second_level_title | default: page.parent }}</a></li>
9595
{% else %}
96-
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
96+
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ first_level_title | default: page.parent }}</a></li>
9797
{% endif %}
98-
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
98+
<li class="breadcrumb-nav-list-item"><span>{{ page.nav_title | default: page.title }}</span></li>
9999
</ol>
100100
</nav>
101101
{% include copy_page.html %}
@@ -117,7 +117,7 @@
117117
{% endcapture %}
118118

119119
<div class="content-with-toc">
120-
<div id="main-content" class="main-content" role="main">
120+
<div id="main-content" class="main-content {{ page.content_class | escape }}" role="main">
121121
{{ rendered_content }}
122122

123123
{% if page.has_children == true and page.has_toc != false %}

‎_sass/custom/custom.scss‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1234,3 +1234,37 @@ details.te-property[open] > .te-property__summary {
12341234
.main-content > h1:first-of-type{
12351235
margin-top: 0 !important;
12361236
}
1237+
1238+
// Give client walkthroughs a quieter title and clear separation between steps.
1239+
.main-content.mcp-client-guide {
1240+
> h1 { font-size: 2rem; line-height: 1.25; margin-bottom: 1rem; }
1241+
> .mcp-lead { font-size: 1.125rem; line-height: 1.6; }
1242+
> h2 { margin-top: 3rem; margin-bottom: 1rem; }
1243+
> ol > li { margin-bottom: 0.75rem; }
1244+
1245+
.mcp-config {
1246+
margin: 1.5rem 0 2rem;
1247+
padding: 1rem 1.25rem;
1248+
border: 1px solid $grey-lt-200;
1249+
border-radius: 6px;
1250+
1251+
summary { cursor: pointer; font-weight: 500; }
1252+
&[open] summary { margin-bottom: 1rem; }
1253+
}
1254+
1255+
@media (max-width: 600px) {
1256+
> h1 { font-size: 1.625rem; }
1257+
}
1258+
}
1259+
1260+
// Prose prompts should stay readable at every viewport width.
1261+
.main-content .language-text.highlighter-rouge {
1262+
.highlight { min-width: 0; }
1263+
1264+
pre,
1265+
pre code {
1266+
white-space: pre-wrap;
1267+
overflow-wrap: anywhere;
1268+
word-break: normal;
1269+
}
1270+
}

0 commit comments

Comments
 (0)