Skip to content

MCP Tools Reference ​

Auto-Generated

This page was auto-generated from MCP server tool metadata on 2026-03-04 21:33 UTC. See source script.

The Specwright MCP server exposes tools for coding agents (Claude Code, Cursor, VS Code Copilot) to query and update the spec knowledge base.

Setup ​

Claude Code ​

Add to your project's .mcp.json:

json
{
  "mcpServers": {
    "specwright": {
      "command": "uvx",
      "args": ["specwright", "mcp"]
    }
  }
}

Cursor / VS Code ​

Add to your MCP configuration with the same command and args.

Tools (11) ​

Search the spec knowledge base using hybrid search (vector + BM25). Returns matching sections with repo, path, title, heading, body snippet, status, and relevance score. Use this to find specs related to what you're working on.

Parameters:

NameTypeRequiredDefault
querystrYes—
repo`strNone`No
status`strNone`No
limitintNo10

get_spec ​

Get a full parsed spec document with frontmatter, sections, acceptance criteria, and status. Returns structured data.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—

get_section ​

Get a single section from a spec by its ID. Returns the section with content, acceptance criteria, and ticket link.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—
section_idstrYes—

get_doc ​

Get raw markdown content of any document from a repository. Use this when you need the unprocessed markdown.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—

list_specs ​

List all spec documents in a repository (using configured doc_paths). Returns metadata (title, status, owner) without full content.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—

list_docs ​

List all indexed document paths in the knowledge base. Optionally filter by repository (e.g. 'owner/repo').

Parameters:

NameTypeRequiredDefault
repo`strNone`No

get_coverage ​

Get spec coverage metrics for the organization. Returns aggregate coverage summary (total specs, sections, ACs, realization rate, health score) and a time-series trend. Optionally filter by repository or team.

Parameters:

NameTypeRequiredDefault
repo`strNone`No
team`strNone`No
daysintNo30

create_spec ​

Create a new spec document in a repository from a template. Commits the file directly to the default branch.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
titlestrYes—
doc_typestrNo'spec'
teamstrNo''
owner_namestrNo''
tags`list[str]None`No
file_name`strNone`No

update_section_status ​

Update the status of a spec section. Modifies the status comment in-place or inserts one if missing, then commits the change.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—
section_idstrYes—
new_statestrYes—

add_realization ​

Add realization evidence to a spec section's acceptance criterion. Links a PR and code location to an AC checkbox.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—
section_idstrYes—
ac_textstrYes—
pr_numberintYes—
code_filestrYes—
linesstrNo''

sync_spec_status ​

Bulk update a spec: apply multiple status updates and realizations in a single commit. More efficient than individual calls.

Parameters:

NameTypeRequiredDefault
ownerstrYes—
repostrYes—
file_pathstrYes—
status_updates`list[dict]None`No
realizations`list[dict]None`No
commit_messagestrNo''

AI-native enterprise documentation platform.