Glyph tools
Four tools for glyphs, a page’s images and icons. Two launch glyph work: finding a page’s glyphs, and generating alt text for the describable ones. Both start a workflow and return its id; neither waits for the result. The other two read that result back: a page’s glyphs with their alt text and status, and a project’s coverage.
There is no workflow status tool on this server. The workflowId the launch tools return is a
handle for support, not something you can poll here. Read the result with list_page_glyphs once
the workflow finishes; get_project_glyph_summary lists the runs still going.
The server has no tool that approves, rejects, edits or redescribes alt text, or sets a glyph’s intent. Those are done in the dashboard.
start_glyph_scan
Section titled “start_glyph_scan”Start a glyph scan for a page.
| Name | Type | Required |
|---|---|---|
page_id | string | yes |
Returns: { workflowId }.
Returns an error block reading Failed to start glyph scan when no workflow id came back, or
Failed to start glyph scan: <message> carrying the underlying error. Read what the scan found with
list_page_glyphs.
describe_glyph_page
Section titled “describe_glyph_page”Describe a page’s describable glyphs in the given languages.
| Name | Type | Required | Notes |
|---|---|---|---|
page_id | string | yes | |
languages | string[] | yes | Language codes, e.g. ["en", "tr"]. |
Returns: { workflowId }.
Returns an error block reading Failed to describe glyph page: <message>. Two common causes: an
empty languages list, and a page with no describable glyphs — run start_glyph_scan first if the
page has never been scanned. Read the alt text it wrote with list_page_glyphs.
list_page_glyphs
Section titled “list_page_glyphs”List a page’s glyphs in one language.
| Name | Type | Required | Notes |
|---|---|---|---|
page_id | string | yes | From list_pages. |
language | string | yes | The language whose alt text and status to read, e.g. en. |
filter | NEEDS_ATTENTION | REJECTED | no | NEEDS_ATTENTION keeps describable glyphs with no approved alt text in language; REJECTED keeps glyphs whose alt text in language was rejected. |
types | string[] | no | Any of img, button, link, input, iframe, video, audio, other. |
intent | describe | decorative | excluded | no | |
first | number | no | Page size, 1–100. Default 20. |
after | string | no | Opaque cursor from a prior page’s endCursor. |
Returns: { totalCount, pageInfo, glyphs }. Each glyph is
{ id, selector, imageSrc, type, intent, status, altText }:
imageSrcisnullfor a glyph with no image source.statusis the glyph’s state inlanguage:APPROVED,REJECTED,PENDING,MISSING,DESCRIBE_FAILED,DECORATIVEorEXCLUDED.altTextis the current alt text inlanguage, ornullwhen none has been written.
Returns an error block reading Page "<page_id>" not found when your credential cannot reach the
page, or Failed to list page glyphs: <message> carrying the underlying error.
get_project_glyph_summary
Section titled “get_project_glyph_summary”Read a project’s glyph coverage in one language.
| Name | Type | Required | Notes |
|---|---|---|---|
project_id | string | yes | |
language | string | yes | The language to count approved, pending and missing alt text in. |
Returns: { glyphCoverage, glyphBlockedPagesCount, runningGlyphScans }:
glyphCoverageholdsdescribableCount,decorativeCount,excludedCount,totalDescribableandtotalMissing;approvedInLang,pendingInLangandmissingInLangforlanguage; andbyLanguage, one{ language, described, approved, pending }per project language.glyphBlockedPagesCountis the number of pages blocked inlanguage.runningGlyphScanslists each scan or describe run still running, as{ kind, workflowId, pageId, startedAt }, wherekindisscanordescribe.
Returns an error block reading Project "<project_id>" not found when your credential cannot reach
the project, or Failed to read project glyph summary: <message> carrying the underlying error.