--- title: "Katman tools: what each MCP tool does and writes" description: "Reference for all 17 Katman MCP tools: what each one does, whether it needs Audit Week or Pro, its key inputs, what it writes, and an example call to copy." url: https://katman.pro/docs/tools lang: en updated: 2026-09-30 --- Docs Updated 30 Sep 2026 # Tools reference > Katman has 17 tools in three groups: method tools for research, planning, prompts and content checks; crawl tools that scan your code and audit your live site; and visibility tools that measure what AI assistants say. Every tool except katman_account needs KATMAN_KEY. Ten work with Audit Week ($3 once, for 7 days) or Katman Pro: they find what’s wrong and tell you what to do. The other six (prompts, page briefs, file generation, IndexNow, monitoring and the dashboard sync) need Pro. All accept project_root, and only two can write outside the .katman folder, when you pass write: true. ## How the tools fit together The tools follow the four steps of [the Katman method](https://katman.pro/method): research, plan, build, verify. Your agent doesn’t need to remember the order: `katman_start` always returns the next call. Every tool accepts `project_root`, the absolute path of your site’s project. If you leave it out, Katman uses `KATMAN_PROJECT_ROOT`, then the root your MCP client reports, then the current folder. Tools return Markdown for the agent, plus structured data where useful. Read-only tools are marked `readOnlyHint`, tools that use the network `openWorldHint`, and no tool is destructive. Parameter names below match the current build; your client shows each tool’s live schema. ## Audit Week and Pro Every tool except `katman_account` needs `KATMAN_KEY`, which comes with Audit Week or Katman Pro ([pricing](https://katman.pro/pricing)): - **Audit Week** costs $3, paid once, for 7 days. It doesn’t renew, and each account can buy it once. It unlocks the ten audit and recommendation tools: it finds what’s wrong and tells you what to do. - **Katman Pro** costs $29/month at the founding price for the first 100 customers (later $49/month), or $290/year. It unlocks every tool: building pages and writing files is Pro. Without a valid key, a tool explains how to get Audit Week or Pro instead of running, and a Pro-only tool called with an Audit Week key explains that it needs Pro. `katman_account` needs no key and shows your plan. How to add the key is in [Getting started](https://katman.pro/docs/getting-started). | Tool | Plan | Group | | --- | --- | --- | | `katman_start` | Audit Week and Pro | Method | | `katman_research` | Audit Week and Pro | Method | | `katman_plan` | Audit Week and Pro | Method | | `katman_lint_content` | Audit Week and Pro | Method | | `katman_report` | Audit Week and Pro | Method | | `katman_scan_code` | Audit Week and Pro | Crawl | | `katman_audit_site` | Audit Week and Pro | Crawl | | `katman_keywords` | Audit Week and Pro | Crawl | | `katman_visibility_run` | Audit Week and Pro | Visibility | | `katman_manual_check` | Audit Week and Pro | Visibility | | `katman_prompt` | Pro | Method | | `katman_page_brief` | Pro | Method | | `katman_generate` | Pro | Method | | `katman_indexnow` | Pro | Crawl | | `katman_setup_monitoring` | Pro | Visibility | | `katman_sync` | Pro | Visibility | | `katman_account` | No key needed | Method | ## Method tools ### katman\_start The entry point. Reads `.katman/`, shows the status of the four steps and returns the next step as an exact tool call. It also adds a one-line plan status. - **Plan:** Audit Week and Pro. - **Inputs:** `site_url` (optional; saved to `config.json`). - **Writes:** `config.json` when you pass `site_url`. ```json { "site_url": "https://your-site.com" } ``` ### katman\_research Creates or updates your research: brand, the four-part sentence, the not-X note, 10–12 situations without your brand name, competitors with source and check date, proof with a source, keywords, and the question set (12 unbranded + 2 diagnostic). It rejects situations that contain your brand, competitors without a URL and check date, and proof without a source, and marks every gap as `[FILL]`. - **Plan:** Audit Week and Pro. - **Inputs:** `mode` (`template`, `update` or `show`); `data` (fields to merge, in `update` mode); `generate_questions: true` builds the 12 + 2 questions from templates. - **Writes:** `research.json` and `research.md`. ```json { "mode": "update", "generate_questions": true } ``` ### katman\_account Shows your plan (Audit Week with the days left, Pro, or none), the features your key unlocks, the masked email of the account, when the key was last checked, and how to connect or upgrade. It’s the one tool that runs without a key. Call it after adding or changing a key. - **Plan:** No key needed. - **Inputs:** none beyond `project_root`. - **Writes:** nothing. Contacts katman.pro only when `KATMAN_KEY` is set. ```json {} ``` ### katman\_plan Builds the page plan and the task list in the book’s 30-day order from your research, scan, audit and latest run. Each task has an id, a prompt code (P0–P14), file hints, an acceptance criterion and the tool that verifies it. - **Plan:** Audit Week and Pro. - **Inputs:** none beyond `project_root`. - **Writes:** `plan.json` and `plan.md`; ticked tasks stay ticked when you regenerate. ```json {} ``` ### katman\_prompt Returns one of the 15 prompts, P0–P14, filled with your research data, together with its acceptance criterion, the reason for it, and how Katman verifies it. It adds notes for your framework, such as prerendering options for a Vite single-page app. - **Plan:** Pro. - **Inputs:** `id` (`P0`–`P14`); `situation_id` (for P6); `lang` (`en` or `tr`). - **Writes:** nothing. ```json { "id": "P6", "situation_id": "s1" } ``` ### katman\_page\_brief A filled page brief: URL, title (situation first, about 60 characters), first sentence, action, proof, who it’s not for, alternatives, FAQ, related pages, the 11-block page anatomy, the JSON-LD to include, and where the file goes in your framework. - **Plan:** Pro. - **Inputs:** `type` (`situation`, `comparison`, `pricing`, `faq`, `about`, `single-question`, `glossary`, `tool` or `home`); `situation_id`; `topic`; `lang`. - **Writes:** nothing. ```json { "type": "situation", "situation_id": "s1" } ``` ### katman\_generate Generates files from your research, which stays the single source of truth: `robots.txt`, `llms.txt`, Organization, WebSite and SoftwareApplication JSON-LD (with your not-X line in `disambiguatingDescription`), FAQPage and BreadcrumbList JSON-LD, an analytics snippet that applies the human filter and the ChatGPT channel rule, a server-side bot counter for your platform (Cloudflare Worker, Next.js middleware, Express, Astro or SvelteKit), and an IndexNow key file. - **Plan:** Pro. - **Inputs:** `artifact` (for example `robots.txt`, `llms.txt`, `organization-jsonld`, `analytics-channel-snippet`, `bot-counter-snippet`); `options`; `write` (default false); `overwrite` (default false). - **Writes:** nothing by default: it returns the content and the target path. With `write: true` it writes that file, and it never replaces an existing file unless you also pass `overwrite: true`. ```json { "artifact": "llms.txt", "write": true } ``` ### katman\_lint\_content Checks a page against the content rules and the P6, P7 and P8 acceptance criteria: the first 1–3 sentences answer on their own, the one sentence matches your research and llms.txt, no hype words, no unsourced numbers, no placeholders, an update date, 5–8 FAQs, a not-for section, alternatives, at least 3 internal links, and title and description lengths. - **Plan:** Audit Week and Pro. - **Inputs:** one of `file`, `url` or `text`; `page_type` (for example `situation` or `comparison`). - **Writes:** nothing. ```json { "url": "https://your-site.com/your-situation-page", "page_type": "situation" } ``` ### katman\_report Summarises research completeness, the latest audit’s gate pass rates, visibility changes since the last run, the competitors and domains assistants cite most, plan progress, the top 10 open issues and the next 7 days. - **Plan:** Audit Week and Pro. - **Writes:** `report.md`. ```json {} ``` ## Crawl tools ### katman\_scan\_code A deterministic scan of your codebase: framework and version, builder signatures (Lovable, Bolt, v0, Replit), a rendering verdict (server, static, hybrid or browser-only) with evidence, hosting and preview-URL patterns, public versus app routes, where head tags come from, robots, sitemap, llms.txt, 404 page, JSON-LD, hreflang, onClick navigation, images without alt or size, and whether analytics counts AI visitors. - **Plan:** Audit Week and Pro. - **Writes:** `scan.json`. ```json {} ``` ### katman\_audit\_site Audits the live site the way AI crawlers see it: robots.txt (AI bot rules, bare prefixes, Cloudflare’s managed block), sitemaps, redirects, HSTS, compression, soft 404s, llms.txt, AI bot access through your CDN or firewall, and for each page its status, noindex, title, description, canonical, headings, words visible without JavaScript, first paragraph, JSON-LD, Open Graph, language, hreflang, images and internal links. Pass `urls` for a quick check of specific pages after a deploy. - **Plan:** Audit Week and Pro. - **Inputs:** `site_url` (your site) or `urls` (quick verify mode); `max_urls` (50 by default); `include_bot_test`; `preview_urls`. - **Writes:** `audits/