artifacty 0.3.0 → 0.4.0

package/README.md

@@ -175,6 +175,10 @@ artifacty-mcp
 ```
 
 MCP clients can create artifacts with `artifacty_create`. `artifacty_publish` remains as a backwards-compatible alias.
+MCP clients that support resources or prompts can also read `artifacty://recent`,
+`artifacty://artifacts/{id}`, `artifacty://artifacts/{id}/raw{?version}`, and
+`artifacty://schema/v1`, or use prompt templates such as `artifacty_handoff`,
+`artifacty_review`, and `artifacty_release_notes`.
 
 Operational commands:
 
@@ -275,6 +279,7 @@ Schema and storage:
 - Diagram, component, source snippet, analysis report, table, and media assets use `diagram`, `component`, `snippet`, `analysis-report`, `table`, and `asset` artifact types.
 - Copilot/Cursor examples cover PR reviews, screenshots, demo recordings, and visual evidence bundles.
 - See [docs/artifact-schema-v1.md](docs/artifact-schema-v1.md).
+- See [docs/mcp-public-api.md](docs/mcp-public-api.md) for MCP tools, resources, prompts, and compatibility notes.
 - See [docs/sarif-csv-artifact-plan.md](docs/sarif-csv-artifact-plan.md) for the SARIF/CSV output artifact roadmap.
 
 ## Security Model

package/docs/integrations.md

@@ -83,7 +83,21 @@ node src/cli.js check
 - Cursor: writes project `.cursor/mcp.json` using the Cursor `mcpServers` shape. Pass `--config ~/.cursor/mcp.json` for global Cursor setup.
 - `--dry-run` returns the generated config without writing it.
 - `--timeout <ms>` adjusts Codex `startup_timeout_sec` and Gemini `timeout`. It does not change Claude Code startup behavior; set `MCP_TIMEOUT` before launching Claude Code if you need a larger value there.
-- `check` starts the local MCP server and verifies required tools through `initialize` and `tools/list`.
+- `check` starts the local MCP server and verifies required tools, resources, and prompts through MCP discovery methods.
+
+## Client Compatibility Matrix
+
+| Client | Config shape | Scope | Timeout behavior | Restart requirement | Notes |
+| --- | --- | --- | --- | --- | --- |
+| Claude Code | `.mcp.json` `mcpServers` | project | parent `MCP_TIMEOUT`, default 30s | restart Claude Code | no per-server startup timeout field |
+| Codex | TOML `[mcp_servers.artifacty]` | user or explicit config | `startup_timeout_sec = 30.0` | restart Codex session | Windows cold starts may need the 30s default |
+| Gemini CLI | JSON `mcpServers` | user or project | `timeout: 30000` | reload `/mcp` or restart | `trust` is preserved from installer options |
+| GitHub Copilot in VS Code | `.vscode/mcp.json` `servers` | workspace or user profile | client-managed | reload VS Code MCP server | tools are the primary tested surface |
+| Cursor | `.cursor/mcp.json` `mcpServers` | workspace or global | client-managed | restart/reload Cursor MCP | tools are the primary tested surface |
+
+All clients should support MCP tools. Resource and prompt display varies by
+client, so Artifacty's core workflows continue to work through tools even when a
+client does not expose resources or prompts in its UI.
 
 Generate a token for protected HTTP routes:
 
@@ -196,6 +210,25 @@ Then run `/mcp` inside Gemini CLI to confirm that the Artifacty tools are connec
 
 Mutating MCP tools scan content for common API keys and private keys before storage. Pass `allowSecrets: true` only for intentional exceptions.
 
+## MCP Resources and Prompts
+
+Artifacty also exposes read-only MCP resources:
+
+- `artifacty://recent`: recent artifacts with pagination and browser URLs.
+- `artifacty://schema/v1`: Artifact schema v1 Markdown.
+- `artifacty://artifacts/{id}`: artifact JSON with metadata, content, and URLs.
+- `artifacty://artifacts/{id}/raw{?version}`: raw latest or versioned content.
+
+Prompt templates:
+
+- `artifacty_handoff`: continuation handoff.
+- `artifacty_review`: findings-first code review artifact.
+- `artifacty_test_report`: verification evidence.
+- `artifacty_visual_qa`: screenshot/media/browser evidence.
+- `artifacty_release_notes`: release notes with publish evidence and risks.
+
+See [mcp-public-api.md](mcp-public-api.md) for the public MCP surface.
+
 ## Importing Agent Artifacts
 
 Use `artifacty_import` or the CLI `import` command when the artifact was produced by another agent and needs normalization before sharing.

package/docs/mcp-public-api.md

@@ -0,0 +1,68 @@
+# MCP Public API
+
+Artifacty's MCP stdio server is the primary agent-to-agent integration surface.
+The server currently targets MCP protocol `2025-06-18`.
+
+## Capabilities
+
+`initialize` advertises:
+
+- `tools`: Artifact create, import, list, get, update, archive, restore, audit, and info.
+- `resources`: static and dynamic read-only artifact resources.
+- `prompts`: reusable workflow prompt templates.
+
+## Tools
+
+Stable tool names:
+
+- `artifacty_create`: create a native Artifacty artifact.
+- `artifacty_publish`: backwards-compatible alias for `artifacty_create`.
+- `artifacty_import`: convert external Claude, Codex, Gemini, Copilot, Cursor, Artifacty, or generic payloads.
+- `artifacty_list`: list artifacts with `query`, `tag`, `sourceAgent`, `includeArchived`, `limit`, and `offset`.
+- `artifacty_get`: read one artifact by `id` and optional `version`.
+- `artifacty_update`: append an immutable version.
+- `artifacty_archive` / `artifacty_restore`: toggle archive state.
+- `artifacty_audit`: list audit events.
+- `artifacty_info`: return local store and browser URL information.
+
+Tool schemas use Artifacty schema v1 formats and artifact types. New optional
+properties may be added during 0.x releases; existing names should not be
+renamed without a documented migration.
+
+## Resources
+
+Static resources:
+
+- `artifacty://recent`: JSON list of recent artifacts with pagination and browser URLs.
+- `artifacty://schema/v1`: Markdown reference for Artifacty schema v1.
+
+Resource templates:
+
+- `artifacty://artifacts/{id}`: JSON artifact metadata, selected version, content, and URLs.
+- `artifacty://artifacts/{id}/raw{?version}`: raw artifact content for latest or specified version.
+
+Resources are read-only and may record an audit `read` event for artifact content.
+
+## Prompts
+
+Prompt names:
+
+- `artifacty_handoff`
+- `artifacty_review`
+- `artifacty_test_report`
+- `artifacty_visual_qa`
+- `artifacty_release_notes`
+
+Each prompt returns one user message that instructs an agent to create or update
+an Artifacty artifact with discoverable `artifactType`, `sourceAgent`, and tags.
+Prompts accept optional context arguments such as `artifactId`, `goal`, `scope`,
+`target`, or `version`.
+
+## Compatibility Notes
+
+- The MCP server is local stdio only. Remote MCP auth/OAuth is out of scope.
+- Binary media resources return stored base64 text through MCP; browser `/raw`
+  decodes first-class `image` and `video` artifacts into bytes.
+- Clients may display resources and prompts differently. Tools remain the most
+  widely supported integration path across Claude, Codex, Gemini, Copilot, and
+  Cursor.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artifacty",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Local artifact exchange for heterogeneous LLM agents via HTTP and MCP.",
   "type": "module",
   "keywords": [
@@ -37,6 +37,7 @@
     "docs/artifact-schema-v1.md",
     "docs/assets/artifacty.png",
     "docs/integrations.md",
+    "docs/mcp-public-api.md",
     "docs/network-sharing.md",
     "docs/release-checklist.md",
     "docs/sarif-csv-artifact-plan.md",

package/src/lib/check.js

@@ -14,10 +14,25 @@ export const REQUIRED_MCP_TOOLS = [
   "artifacty_info"
 ];
 
+export const REQUIRED_MCP_RESOURCES = [
+  "artifacty://recent",
+  "artifacty://schema/v1"
+];
+
+export const REQUIRED_MCP_PROMPTS = [
+  "artifacty_handoff",
+  "artifacty_review",
+  "artifacty_test_report",
+  "artifacty_visual_qa",
+  "artifacty_release_notes"
+];
+
 export async function checkMcpTools(options = {}) {
   const projectDir = path.resolve(options.projectDir || process.cwd());
   const serverPath = path.resolve(options.serverPath || path.join(projectDir, "src", "mcp-server.js"));
   const requiredTools = options.requiredTools || REQUIRED_MCP_TOOLS;
+  const requiredResources = options.requiredResources || REQUIRED_MCP_RESOURCES;
+  const requiredPrompts = options.requiredPrompts || REQUIRED_MCP_PROMPTS;
   const timeoutMs = Number(options.timeout || 5000);
   const client = spawnMcpClient({
     serverPath,
@@ -39,14 +54,26 @@ export async function checkMcpTools(options = {}) {
     const listed = await client.request("tools/list", {});
     const toolNames = (listed.tools || []).map((tool) => tool.name).sort();
     const missingTools = requiredTools.filter((tool) => !toolNames.includes(tool));
+    const listedResources = await client.request("resources/list", {});
+    const resourceUris = (listedResources.resources || []).map((resource) => resource.uri).sort();
+    const missingResources = requiredResources.filter((resource) => !resourceUris.includes(resource));
+    const listedPrompts = await client.request("prompts/list", {});
+    const promptNames = (listedPrompts.prompts || []).map((prompt) => prompt.name).sort();
+    const missingPrompts = requiredPrompts.filter((prompt) => !promptNames.includes(prompt));
 
     return {
-      ok: missingTools.length === 0,
+      ok: missingTools.length === 0 && missingResources.length === 0 && missingPrompts.length === 0,
       serverPath,
       protocolVersion: initialized.protocolVersion,
       toolCount: toolNames.length,
+      resourceCount: resourceUris.length,
+      promptCount: promptNames.length,
       tools: toolNames,
-      missingTools
+      resources: resourceUris,
+      prompts: promptNames,
+      missingTools,
+      missingResources,
+      missingPrompts
     };
   } finally {
     client.close();

package/src/mcp-server.js

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
+import { readFile } from "node:fs/promises";
+import path from "node:path";
 import readline from "node:readline";
+import { fileURLToPath } from "node:url";
 import {
   ARTIFACT_FORMATS,
   ARTIFACT_TYPES,
@@ -16,6 +19,7 @@ import { convertAgentArtifact } from "./lib/converters.js";
 import { resolvePublicBaseUrl } from "./lib/server-state.js";
 
 const PROTOCOL_VERSION = "2025-06-18";
+const PACKAGE_ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
 const store = createStore();
 
 const nativeArtifactInputSchema = {
@@ -255,6 +259,71 @@ const tools = [
   }
 ];
 
+const resourceTemplates = [
+  {
+    uriTemplate: "artifacty://artifacts/{id}",
+    name: "artifact-by-id",
+    title: "Artifact by ID",
+    description: "Read an Artifacty artifact with metadata, latest version, content, and browser URLs.",
+    mimeType: "application/json"
+  },
+  {
+    uriTemplate: "artifacty://artifacts/{id}/raw{?version}",
+    name: "artifact-raw-content",
+    title: "Artifact Raw Content",
+    description: "Read raw artifact content by ID and optional version.",
+    mimeType: "text/plain"
+  }
+];
+
+const prompts = [
+  {
+    name: "artifacty_handoff",
+    title: "Create Artifact Handoff",
+    description: "Prepare a concise continuation artifact for another agent.",
+    arguments: [
+      { name: "goal", description: "Current goal or handoff objective.", required: false },
+      { name: "artifactId", description: "Existing Artifacty artifact to continue from.", required: false }
+    ]
+  },
+  {
+    name: "artifacty_review",
+    title: "Create Review Artifact",
+    description: "Capture code review findings as a shareable Artifacty artifact.",
+    arguments: [
+      { name: "scope", description: "Files, branch, PR, or behavior under review.", required: false },
+      { name: "artifactId", description: "Existing artifact with review context.", required: false }
+    ]
+  },
+  {
+    name: "artifacty_test_report",
+    title: "Create Test Report Artifact",
+    description: "Summarize verification commands, status, failures, and residual risk.",
+    arguments: [
+      { name: "goal", description: "Feature or release being verified.", required: false },
+      { name: "artifactId", description: "Existing artifact with implementation context.", required: false }
+    ]
+  },
+  {
+    name: "artifacty_visual_qa",
+    title: "Create Visual QA Artifact",
+    description: "Record browser, screenshot, media, or visual regression evidence.",
+    arguments: [
+      { name: "target", description: "URL, artifact ID, or UI surface under visual review.", required: false },
+      { name: "artifactId", description: "Existing visual evidence artifact.", required: false }
+    ]
+  },
+  {
+    name: "artifacty_release_notes",
+    title: "Create Release Notes Artifact",
+    description: "Draft release notes from changed artifacts, tests, and known risks.",
+    arguments: [
+      { name: "version", description: "Release version.", required: false },
+      { name: "artifactId", description: "Existing roadmap, checklist, or handoff artifact.", required: false }
+    ]
+  }
+];
+
 const rl = readline.createInterface({
   input: process.stdin,
   crlfDelay: Infinity
@@ -311,14 +380,21 @@ async function handleRequest(message) {
       capabilities: {
         tools: {
           listChanged: false
+        },
+        resources: {
+          subscribe: false,
+          listChanged: false
+        },
+        prompts: {
+          listChanged: false
         }
       },
       serverInfo: {
         name: "artifacty",
         title: "Artifacty",
-        version: "0.3.0"
+        version: "0.4.0"
       },
-      instructions: "Use Artifacty to create, import, list, read, and update local artifacts that other agents can reuse."
+      instructions: "Use Artifacty to create, import, list, read, update, and resource-read local artifacts that other agents can reuse."
     };
   }
 
@@ -335,6 +411,27 @@ async function handleRequest(message) {
     return callTool(params.name, params.arguments || {});
   }
 
+  if (message.method === "resources/list") {
+    return listResources();
+  }
+
+  if (message.method === "resources/templates/list") {
+    return { resourceTemplates };
+  }
+
+  if (message.method === "resources/read") {
+    return readResource(requireParam(message.params, "uri"));
+  }
+
+  if (message.method === "prompts/list") {
+    return { prompts };
+  }
+
+  if (message.method === "prompts/get") {
+    const params = message.params || {};
+    return getPrompt(requireParam(params, "name"), params.arguments || {});
+  }
+
   throw Object.assign(new Error(`Method not found: ${message.method}`), {
     jsonRpcCode: -32601
   });
@@ -440,6 +537,177 @@ async function callTool(name, args) {
   });
 }
 
+async function listResources() {
+  const page = await listArtifactsPage(store, { limit: 10 });
+  const artifactResources = page.artifacts.flatMap((artifact) => [
+    {
+      uri: artifactResourceUri(artifact.id),
+      name: `artifact:${artifact.id}`,
+      title: artifact.title,
+      description: `${artifact.sourceAgent} ${artifact.artifactType} artifact, v${artifact.latestVersion}`,
+      mimeType: "application/json"
+    },
+    {
+      uri: artifactRawResourceUri(artifact.id),
+      name: `artifact-raw:${artifact.id}`,
+      title: `${artifact.title} raw`,
+      description: `Raw latest ${artifact.format || "text"} content for ${artifact.id}`,
+      mimeType: artifact.contentType || "text/plain"
+    }
+  ]);
+
+  return {
+    resources: [
+      {
+        uri: "artifacty://recent",
+        name: "recent-artifacts",
+        title: "Recent Artifacts",
+        description: "Recent Artifacty artifacts with pagination metadata and browser URLs.",
+        mimeType: "application/json"
+      },
+      {
+        uri: "artifacty://schema/v1",
+        name: "artifact-schema-v1",
+        title: "Artifact Schema v1",
+        description: "Artifacty schema v1 reference document.",
+        mimeType: "text/markdown"
+      },
+      ...artifactResources
+    ]
+  };
+}
+
+async function readResource(uri) {
+  if (uri === "artifacty://recent") {
+    const publicBaseUrl = await resolvePublicBaseUrl(store);
+    const page = await listArtifactsPage(store, { limit: 20 });
+    return resourceText(uri, "application/json", {
+      artifacts: page.artifacts.map((artifact) => ({
+        ...artifact,
+        url: `${publicBaseUrl}/artifacts/${encodeURIComponent(artifact.id)}`
+      })),
+      pagination: {
+        total: page.total,
+        limit: page.limit,
+        offset: page.offset,
+        hasMore: page.hasMore,
+        nextOffset: page.nextOffset,
+        previousOffset: page.previousOffset
+      },
+      search: page.search
+    });
+  }
+
+  if (uri === "artifacty://schema/v1") {
+    return {
+      contents: [
+        {
+          uri,
+          mimeType: "text/markdown",
+          text: await readFile(path.join(PACKAGE_ROOT, "docs", "artifact-schema-v1.md"), "utf8")
+        }
+      ]
+    };
+  }
+
+  const parsed = parseArtifactResourceUri(uri);
+  if (parsed) {
+    const artifact = await getArtifact(store, parsed.id, {
+      version: parsed.version,
+      audit: mcpAuditContext()
+    });
+    if (parsed.raw) {
+      return {
+        contents: [
+          {
+            uri,
+            mimeType: artifact.version.contentType || "text/plain",
+            text: artifact.content
+          }
+        ]
+      };
+    }
+    return resourceText(uri, "application/json", await withUrls(artifact));
+  }
+
+  throw Object.assign(new Error(`Unknown resource: ${uri}`), {
+    jsonRpcCode: -32602
+  });
+}
+
+function getPrompt(name, args) {
+  const definition = prompts.find((prompt) => prompt.name === name);
+  if (!definition) {
+    throw Object.assign(new Error(`Unknown prompt: ${name}`), {
+      jsonRpcCode: -32602
+    });
+  }
+
+  return {
+    description: definition.description,
+    messages: [
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: promptText(name, args)
+        }
+      }
+    ]
+  };
+}
+
+function promptText(name, args = {}) {
+  const context = args.artifactId
+    ? `First read Artifacty resource ${artifactResourceUri(args.artifactId)} and use it as context.`
+    : "Use the current session context and any relevant Artifacty resources.";
+  const common = `${context}
+
+Create or update an Artifacty artifact through artifacty_create, artifacty_import, or artifacty_update. Use concise Markdown unless another format is clearly better. Include sourceAgent, artifactType, and tags so another agent can discover it.`;
+
+  if (name === "artifacty_handoff") {
+    return `${common}
+
+Goal: ${args.goal || "Prepare a continuation handoff for the next agent."}
+
+Capture: current state, changed files or artifacts, commands run, decisions, blockers, residual risk, and next steps.
+Recommended artifactType: handoff. Recommended tags: handoff, continuation.`;
+  }
+  if (name === "artifacty_review") {
+    return `${common}
+
+Review scope: ${args.scope || "Review the current implementation or linked artifact."}
+
+Capture findings first, ordered by severity, with file/line references when available. Include open questions and verification gaps.
+Recommended artifactType: code-review. Recommended tags: review.`;
+  }
+  if (name === "artifacty_test_report") {
+    return `${common}
+
+Verification goal: ${args.goal || "Summarize test and smoke evidence."}
+
+Capture commands, status, failures, environment, manual checks, and what remains untested.
+Recommended artifactType: test-report. Recommended tags: verification, test-report.`;
+  }
+  if (name === "artifacty_visual_qa") {
+    return `${common}
+
+Visual target: ${args.target || "Inspect the UI or visual artifact under review."}
+
+Capture screenshots/media references, viewport, expected behavior, observed issues, and pass/fail verdict.
+Recommended artifactType: design-option or bundle. Recommended tags: visual, qa.`;
+  }
+  if (name === "artifacty_release_notes") {
+    return `${common}
+
+Release version: ${args.version || "next"}
+
+Capture highlights, breaking changes, migration notes, tests, known limitations, and publish evidence.
+Recommended artifactType: document. Recommended tags: release-notes.`;
+  }
+  return common;
+}
+
 async function createNativeArtifact(args) {
   return createArtifact(store, {
     title: args.title,
@@ -471,6 +739,49 @@ async function withUrls(artifact) {
   };
 }
 
+function resourceText(uri, mimeType, data) {
+  return {
+    contents: [
+      {
+        uri,
+        mimeType,
+        text: typeof data === "string" ? data : JSON.stringify(data, null, 2)
+      }
+    ]
+  };
+}
+
+function artifactResourceUri(id) {
+  return `artifacty://artifacts/${encodeURIComponent(id)}`;
+}
+
+function artifactRawResourceUri(id, version) {
+  const suffix = version ? `?version=${encodeURIComponent(String(version))}` : "";
+  return `artifacty://artifacts/${encodeURIComponent(id)}/raw${suffix}`;
+}
+
+function parseArtifactResourceUri(uri) {
+  let parsed;
+  try {
+    parsed = new URL(uri);
+  } catch {
+    return null;
+  }
+
+  if (parsed.protocol !== "artifacty:" || parsed.hostname !== "artifacts") {
+    return null;
+  }
+  const parts = parsed.pathname.split("/").filter(Boolean);
+  if (parts.length !== 1 && !(parts.length === 2 && parts[1] === "raw")) {
+    return null;
+  }
+  return {
+    id: decodeURIComponent(parts[0]),
+    raw: parts[1] === "raw",
+    version: parsed.searchParams.get("version") || undefined
+  };
+}
+
 function toolResult(data) {
   return {
     content: [
@@ -493,6 +804,15 @@ function requireArg(args, name) {
   return args[name];
 }
 
+function requireParam(params = {}, name) {
+  if (!params[name]) {
+    throw Object.assign(new Error(`Missing required parameter: ${name}`), {
+      jsonRpcCode: -32602
+    });
+  }
+  return params[name];
+}
+
 function writeResponse(id, result, error) {
   const response = {
     jsonrpc: "2.0",