Tools Reference

The VibeMap MCP Server exposes several powerful tools to your AI assistant. Here is a breakdown of each tool and how to use it.

1. list_projects

Retrieves a list of all VibeMap projects owned by you.

  • Usage: Ask Claude "What VibeMap projects do I have?"

  • Returns: An array of project objects containing id, name, and status.

2. get_project_context

Fetches the complete structural details of a specific project.

  • Parameters: projectId (UUID)

  • Returns: Detailed information including the project summary, features, user stories, and acceptance criteria.

  • Best For: Giving Claude the background context needed to write code for a specific feature.

3. scan_codebase

Walks a local directory and returns a visual representation of the file structure.

  • Parameters: path (local filesystem path)

  • Returns: A tree-like string representing folders and files.

  • Best For: Helping the AI understand how your project is physically organized before syncing.

4. sync_to_vibemap (Reverse Engineering)

Analyzes local code and populates VibeMap with matching project assets.

  • Parameters: projectId (UUID), path (local directory to scan)

  • Behavior:

    1. Scans local files for logic patterns.

    2. Identifies implied features and stories.

    3. Calls VibeMap to create these assets if they don't exist.

  • Best For: Bringing an existing codebase under VibeMap management.

5. update_story_status

Updates the development status of a user story in VibeMap.

  • Parameters: storyId (UUID), status (draft, open, in_progress, completed)

  • Best For: Keeping your VibeMap plan in sync with your actual development progress.

Last updated

Was this helpful?