mikuproject-mcp
mikuproject-mcp is a local MCP server adapter for mikuproject.
It exposes mikuproject operations to MCP clients as tools, resources, and
prompts. The server is intended for local stdio use first. It does not call
external AI services, does not start a network listener, and does not replace
the upstream mikuproject product logic.
Status
This repository is currently a Node.js / TypeScript MCP server implementation. The Node package metadata is prepared for a future public package release, but the current validation path is still to build and run it from a local checkout.
Requirements
- Node.js 20 or later
- npm
- Bundled or configured
mikuprojectruntime artifacts
The checked-in runtime artifacts under runtime/ are used by the MCP adapter
for local execution.
Build
npm install
npm run build
The MCP server entrypoint after build is:
packages/node/dist/index.js
The package name prepared for the Node release is:
@igapyon/mikuproject-mcp-node
MCP Client Configuration
Use the built stdio entrypoint from your MCP client configuration.
Example:
{
"mcpServers": {
"mikuproject": {
"command": "node",
"args": ["packages/node/dist/index.js"]
}
}
}
If your MCP client runs from a different working directory, use paths that are valid for that client environment.
Release Tarball Usage
GitHub Releases may provide an npm package tarball asset named like:
igapyon-mikuproject-mcp-node-0.1.0.tgz
After downloading the tarball, install it globally:
npm install -g ./igapyon-mikuproject-mcp-node-0.1.0.tgz
Then configure your MCP client to run the installed command:
{
"mcpServers": {
"mikuproject": {
"command": "mikuproject-mcp"
}
}
}
You can also run the release tarball directly with npm exec without a global
install. Replace the version and URL with the release asset you want to use:
npm exec --yes --package=https://github.com/igapyon/mikuproject-mcp/releases/download/v0.1.0/igapyon-mikuproject-mcp-node-0.1.0.tgz -- mikuproject-mcp
Example MCP client configuration:
{
"mcpServers": {
"mikuproject": {
"command": "npm",
"args": [
"exec",
"--yes",
"--package=https://github.com/igapyon/mikuproject-mcp/releases/download/v0.1.0/igapyon-mikuproject-mcp-node-0.1.0.tgz",
"--",
"mikuproject-mcp"
]
}
}
}
Runtime Configuration
By default, runtime artifacts are resolved from runtime/.
You can override them with environment variables:
MIKUPROJECT_MCP_RUNTIME_NODE=/path/to/mikuproject.mjs
MIKUPROJECT_MCP_WORKSPACE=/path/to/workspace
MIKUPROJECT_MCP_WORKSPACE controls where generated state, projections,
exports, reports, summaries, and diagnostics are written. If it is not set, the
server uses workplace/ under this repository.
Tools
The server exposes product-prefixed tools derived from the upstream CLI command tree.
Core state and AI workflow tools:
mikuproject.ai_specmikuproject.ai_detect_kindmikuproject.state_from_draftmikuproject.ai_export_project_overviewmikuproject.ai_export_task_editmikuproject.ai_export_phase_detailmikuproject.ai_validate_patchmikuproject.state_apply_patchmikuproject.state_diffmikuproject.state_summarize
Import, export, and report tools:
mikuproject.export_workbook_jsonmikuproject.export_xmlmikuproject.export_xlsxmikuproject.import_xlsxmikuproject.report_wbs_markdownmikuproject.report_mermaid
Resources
Common resource URIs include:
mikuproject://spec/ai-jsonmikuproject://state/currentmikuproject://state/{name}mikuproject://export/workbook-jsonmikuproject://export/project-xmlmikuproject://export/project-xlsxmikuproject://report/wbs-markdownmikuproject://report/mermaidmikuproject://summary/{operationId}mikuproject://diagnostics/{operationId}
Tool results include generated artifact paths and, where applicable, product-specific resource URIs.
Prompts
The server provides small product-specific prompts:
mikuproject.create_project_draftmikuproject.revise_state_with_patchmikuproject.review_artifact_diagnostics
Prompt text refers to the AI specification resource instead of duplicating the full product specification.
Diagnostics and Outputs
Tool results are JSON text results with:
okoperationoperationIddiagnostics- generated artifact references
Operation summaries and diagnostics are saved under the workspace and can be read through:
mikuproject://summary/{operationId}mikuproject://diagnostics/{operationId}
Security Notes
This server is intended for trusted local use. It invokes local runtime artifacts and reads or writes local files based on tool arguments and workspace configuration.
Do not configure it with untrusted runtime artifacts or expose it as a hosted network service without a separate design for authentication, workspace isolation, upload handling, storage policy, cleanup, audit, and runtime isolation.
Developer Documentation
Developer-facing repository layout, implementation order, and contract notes are
in docs/development.md and docs/miku-soft-50-mcp-design-v20260427.md.