Interface Reference

The stable command surface for launch.

Pincushion exposes a local CLI, slash-command prompts, MCP tools, and a local health endpoint. This page documents the parts you can rely on in the repo today without advertising internal transport endpoints as a public API.

CLI usage

npx pincushion-mcp [--project-dir /path/to/project]
                   [--sync-url https://...]
                   [--api-key KEY]
                   [--license-key KEY]
                   [--cloud-sync]
                   [--rest --port 3456]

--rest --port 3456 exposes a local health check and bridge for tools that cannot speak MCP directly. The transport used by MCP clients is intentionally not documented here as a public HTTP API.

Slash commands

These are the built-in prompt surfaces shipped for MCP-aware IDEs.

Command Purpose
/pins Show all open feedback pins grouped by page.
/my-pins @username Filter pins where a given user has been @mentioned.
/resolve <pin-id> Claim and resolve a feedback pin.
/feedback-summary Return a project-wide feedback overview.
/setup Register project URLs so the extension auto-activates.
/implement Pull stakeholder-approved pins, create branches, and implement them.

Supported MCP tools

This is the launch-ready public surface exposed by pincushion-mcp.

Tool Purpose
get_annotations List feedback pins from the local .feedback directory with filters.
search_annotations Full-text search across comments, selectors, component names, and tags.
get_feedback_summary Roll up open feedback counts by status, page, and component.
get_component_feedback Summarize feedback targeting a specific component.
get_actionable_pins Return the developer queue for review, follow-up, and auto-agent modes.
implement_approved_pins Fetch the stakeholder-approved work queue before claiming or editing anything.
claim_pin Mark an approved pin as being worked on.
approve_pin Move a pin from open to approved.
fix_and_resolve, resolve_annotation Close the loop after the fix lands.
add_agent_reply Add a thread reply without resolving the pin.
configure_project Associate project URLs with the extension activation rules.
get_setup_instructions Return launch-ready connection instructions for supported IDEs.

Local health endpoint

npx pincushion-mcp --rest --port 3456
curl http://localhost:3456/health

Use the health endpoint to verify that the local bridge is alive. It is the only HTTP endpoint documented here. Tool invocation over HTTP remains an internal transport detail for MCP clients, not a public integration contract.