Package Exports
- @typescape-ai/mcp
Readme
@typescape-ai/mcp
Typescape MCP server for external agent harnesses that need canonical review, finding, decision, rules, corpus, and export workflows.
The published package exposes a broad multi-family tool registry for review, finding, workflow, rules, advisory, project, issue, and repository operations. MCP is the easiest discovery surface for agent clients such as Claude Code, Cursor, and Windsurf, but it is not the whole product surface. Typescape also ships the same operating model over the API and CLI.
Requirements
- Bun
>=1.0is preferred - Node.js
>=18.17also works fornpx-style launchers TYPESCAPE_API_KEYandTYPESCAPE_BASE_URL
Install
Preferred ephemeral launch:
bunx @typescape-ai/mcpIf you want to pin the package in a repo:
bun add -D @typescape-ai/mcpNode-based MCP clients can also launch it without installing Bun:
npx -y @typescape-ai/mcpClient Config
Generic MCP config shape:
{
"mcpServers": {
"typescape": {
"command": "bunx",
"args": ["@typescape-ai/mcp"],
"env": {
"TYPESCAPE_API_KEY": "ts_op_your_token",
"TYPESCAPE_BASE_URL": "https://your-typescape-instance.example.com"
}
}
}
}Claude Code example: ~/.claude/mcp.json
{
"mcpServers": {
"typescape": {
"command": "bunx",
"args": ["@typescape-ai/mcp"],
"env": {
"TYPESCAPE_API_KEY": "ts_op_your_token",
"TYPESCAPE_BASE_URL": "https://your-typescape-instance.example.com"
}
}
}
}Cursor example: .cursor/mcp.json
{
"mcpServers": {
"typescape": {
"command": "npx",
"args": ["-y", "@typescape-ai/mcp"],
"env": {
"TYPESCAPE_API_KEY": "ts_op_your_token",
"TYPESCAPE_BASE_URL": "https://your-typescape-instance.example.com"
}
}
}
}Canonical Workflows
Review workflow:
typescape_create_reviewtypescape_get_rendertypescape_create_findingtypescape_post_comment/typescape_record_decisiontypescape_export_review
Rules workflow:
typescape_get_rulestypescape_check_contenttypescape_import_rulestypescape_rules_dashboard
API/CLI parity:
- API is the canonical automation contract. See ../../docs/api.md.
- CLI is the first-class terminal surface for the same review and rules workflows. See ../cli/README.md.
- MCP is the adapter/discovery surface for agent clients that already speak MCP.
Tool Families
Reviews:
typescape_create_reviewtypescape_revise_reviewtypescape_export_reviewtypescape_list_reviewstypescape_get_reviewtypescape_get_rendertypescape_search_reviewstypescape_close_reviewtypescape_reopen_reviewtypescape_export_response_matrix
Findings, comments, decisions, and evidence:
typescape_list_findingstypescape_search_findingstypescape_create_findingtypescape_post_commenttypescape_resolve_findingtypescape_reopen_findingtypescape_record_decisiontypescape_attach_evidencetypescape_get_decisiontypescape_list_evidence
Review sets and refs:
typescape_create_review_settypescape_export_review_settypescape_create_review_reftypescape_resolve_review_reftypescape_advance_review_ref
Approvals, checks, account, and capabilities:
typescape_request_approvaltypescape_get_statustypescape_run_checkstypescape_account_usagetypescape_account_plantypescape_get_capabilities
Corpus:
typescape_get_snapshottypescape_list_backlinkstypescape_get_impact
Rules:
typescape_get_rulestypescape_rules_pack(compatibility-only)typescape_check_contenttypescape_import_rulestypescape_rules_dashboard
Repo, asset, and collection support:
typescape_list_repostypescape_connect_repotypescape_repo_branchestypescape_upload_reviewer_assettypescape_create_collectiontypescape_add_review_to_collection
Notes
- Feature-gated tools return
feature_disabledwhen the backing capability is off for the tenant.
Response Shape
Every MCP tool returns JSON text in content[0].text.
Success example:
{
"content": [
{
"type": "text",
"text": "{\"review_id\":\"sess_01HX...\",\"request_id\":\"req_abc123\"}"
}
]
}Error example:
{
"error": {
"code": "review_not_found",
"message": "No review with that ID exists.",
"retryable": false,
"request_id": "req_abc123"
}
}Environment
| Variable | Required | Description |
|---|---|---|
TYPESCAPE_API_KEY |
Yes | Operator API token |
TYPESCAPE_BASE_URL |
Yes | Typescape server base URL |
License
MIT