Guide · VS Code extensions

How do VS Code extensions get recommended by AI?

Updated 2026-11-09 · kagentx

Short answer

Write the description in package.json and the first paragraph of the README well. Tested on 2026-11-09: VS Code Marketplace extension detail pages are not blocked by robots.txt, the page title is the display name, the meta description is a fixed prefix plus the description from package.json, and the README body is directly in the HTML; an Open VSX extension page is an empty shell of about 4.9 KB, the data is in a public API, and its robots.txt names no AI crawler. The official documentation says keywords are limited to 30; write only what is really supported. A website landing page adds the structured data and comparisons the store page cannot hold. Whether AI cites these store pages is not stated officially and we have not verified it.

Can AI read pages on the VS Code Marketplace?

Quite a lot. On 2026-11-09 we read the Marketplace robots.txt and one extension detail page (Prettier): the detail page is not blocked by robots.txt, each extension has its own title and description, and the README body is written directly into the HTML. Whether AI reads and cites these pages is not stated officially and we have not verified it.

What we checkedResult (2026-11-09)What it tells you
robots.txtUser-agent *: Disallow /_apis/ , /publishers/ ; SitemapExtension detail pages can be fetched; publisher pages cannot; no AI crawler is named
titlePrettier - Code formatter - Visual Studio MarketplaceThe extension's display name plus the store name, different for every extension
meta description / og:descriptionExtension for Visual Studio Code - Code formatter using prettierA fixed prefix plus the description from package.json, so the description is the page description
README bodyDirectly in the HTML (server-rendered); external links in the README carry nofollowThe README can be read without running scripts
Structured dataNo JSON-LDThe page markup has no data such as SoftwareApplication

This differs from the Chrome Web Store, where title and share tags are generic for the whole store (see How do I get my Chrome extension recommended by AI?). For a VS Code extension, displayName, description and README are the page title, description and body, so write them with care.

Can AI read pages on Open VSX?

Not much from the page itself, but the data is public. An Open VSX extension page is only about 4.9 KB, its title is the generic "Open VSX Registry", it has no description, and the content is rendered by script. The public API for the same extension returns JSON with name, description, categories, tags, repository and download count. Whether AI crawlers read this API is not verified.

What we checkedResult (2026-11-09)
robots.txtNames a long list of old crawlers and scraping tools (such as MJ12bot, Wget, HTTrack) with Disallow: /; all other crawlers Allow: /, Crawl-delay: 2; GPTBot, ClaudeBot and PerplexityBot are not named
/extension/esbenp/prettier-vscodeHTTP 200, 4,885 bytes, title: Open VSX Registry
/api/esbenp/prettier-vscodeJSON: displayName, description, categories, tags, repository, homepage, license, downloadCount, averageRating, reviewCount, verified
tagsFrom the keywords in package.json (plus internal tags starting with __ext_)

In the Prettier example, the name, description and tags in the Open VSX API match displayName, description and keywords in package.json. So a well-written package.json helps the pages on both sites; whether Open VSX shows the README in the same way is not verified.

Which package.json fields affect what AI sees?

displayName, description, keywords, categories, repository and homepage. Below are the official documentation's requirements (viewed 2026-11-09) and our suggested wording.

FieldDocsHow to write it
displayNameMust be unique in the storeName plus one word that says the function, such as "Example SQL Formatter"; it becomes the page title
descriptionOne sentence saying what the extension is and doesOne sentence with the object and the ability: "Format SQL files in VS Code with one command; supports PostgreSQL, MySQL and SQLite." It becomes the page's meta description
keywordsAt most 30; merged into the store tagsWrite only languages, frameworks and tasks it really supports, 5–10 of them; do not pile on unrelated popular words
categoriesOnly chosen from 17 fixed valuesPick the one or two that truly fit; Language Packs is only for display-language extensions
repository / homepageShown in the store's Resources sectionPut the public repository in repository (also used to rewrite relative links in the README); put the website landing page in homepage
iconPNG, at least 128x128Use PNG, not SVG
{
  "name": "example-sql-formatter",
  "displayName": "Example SQL Formatter",
  "description": "Format SQL files in VS Code with one command; supports PostgreSQL, MySQL and SQLite dialects.",
  "version": "1.4.0",
  "publisher": "example-publisher",
  "categories": ["Formatters"],
  "keywords": ["sql", "formatter", "postgresql", "mysql", "sqlite"],
  "repository": { "type": "git", "url": "https://github.com/example/sql-formatter.git" },
  "homepage": "https://example.com/sql-formatter/",
  "icon": "images/icon.png"
}

Above is an example; the names and URLs are placeholders. The official documentation only says that description and displayName help search inside the store; it does not say whether they affect AI answers, and that is not verified.

How should a README open?

README.md is the body of the store page (official documentation), so the first paragraph should read like an answer that can be quoted directly.

  1. 1. Write the definition in the first paragraph

    "Example SQL Formatter is a VS Code extension that formats SQL files with one command and supports PostgreSQL, MySQL and SQLite." Do not write "powerful" or "revolutionary".

  2. 2. Follow with a table: what is supported

    Supported languages or dialects, the minimum VS Code version, and whether editors that use Open VSX are supported.

  3. 3. A minimal example that can be copied

    Command names in the command palette and settings JSON, in code blocks.

  4. 4. List the settings

    The name, default value and effect of each setting, as a table.

  5. 5. Use https for images and write alt text

    The official documentation requires images in the README to be https URLs, with SVG allowed only from trusted badge providers. Do not put important information only in screenshots.

  6. 6. Link to the website and the changelog

    For changelogs see Do changelog pages help AI search?; for general README writing see Will AI search cite my GitHub README?.

Do you still need a website?

Yes. You cannot change the layout of the store page or add structured data there; a website landing page can hold a one-sentence definition, comparison pages, structured data and an update date. Point the homepage field at it. For landing pages, comparison pages and AI crawl checks see How do developer docs get cited by AI search?, How do open-source projects get recommended by AI? and Does structured data help AI search?.

First use AI crawler check to confirm the website does not block AI crawlers (rules in How do you write robots.txt for AI crawlers?), then confirm the body text does not depend on scripts (see Do AI crawlers render JavaScript?).

If the extension is an AI coding assistant, the specific questions are in How do AI tool products get recommended by ChatGPT?.

If you build a Raycast extension, see How do Raycast extensions get found by AI search? for how to write the store page and package.json.

If you build a JetBrains plugin, see How do AI search tools find JetBrains plugins? The Marketplace plugin page, tested for a test of the Marketplace robots.txt, sitemap and plugin page fields.

If you build a Figma plugin, the Figma Community plugin page's robots.txt, sitemap and the vendor's listing requirements are in How do AI search tools find Figma plugins? The Community plugin page's robots.txt, sitemap and Figma's requirements.

FAQ

Will ChatGPT cite VS Code Marketplace pages?

We found no official statement and no actual citation evidence, so this is not verified. What we can confirm: extension detail pages are not blocked by robots.txt, and the page has the extension's own title, description and README body (tested 2026-11-09).

How many keywords can I write?

The official extension manifest documentation (viewed 2026-11-09) says at most 30. We suggest only 5–10 languages, frameworks and tasks that are really supported.

Where do I write the description and what is it for?

Write it in the description field of package.json. The meta description of the Marketplace page is the fixed prefix "Extension for Visual Studio Code - " plus this sentence, so say in one sentence what the extension does.

Do I need to publish to Open VSX separately?

Open VSX is a separate site from the Marketplace, with its own pages and API. Whether you need to publish separately is for Open VSX's own documentation to say, and we have not verified it; the official VS Code publishing documentation does not mention Open VSX. Either way the same package.json and README are used.

How does this differ from Chrome extensions?

On a Chrome Web Store detail page the title and share tags are generic for the whole store and the extension's description is in embedded script data; on the VS Code Marketplace the title, description and README body are the extension's own. So package.json and the README matter more for a VS Code extension than the store fields do for a Chrome extension.

Sources

kagentx

Can crawlers read your pages?
Let the evaluation tell you

The evaluation checks whether crawlers can get in and whether the text is served directly, then asks ChatGPT, Perplexity and Claude (with web search on) your buyers' questions and sees whether you are mentioned. The Basic plan is $1, and results usually take 2–3 minutes.