Skip to main content
Neo Docs MCP Hero The Neo Docs MCP (Model Context Protocol) server provides AI coding assistants like Cursor with direct access to Neo’s complete documentation. This enables more accurate and context-aware assistance when working with Neo widgets, theming, and utilities.

​
What is MCP?

MCP (Model Context Protocol) is a standard protocol that allows AI assistants to access external data sources and tools. By connecting the Neo Docs MCP server to your development environment, your AI assistant can reference the latest Neo documentation when helping you write code.

​
Installation

We strongly recommend configuring your MCP servers per-project to keep your development environment clean and contained. This ensures each project has its own context, reducing token usage and improving LLM performance.
  1. Create the configuration file - In your project root, create mcp.json in the appropriate directory for your IDE:
    • Cursor: .cursor/mcp.json
    • Windsurf: .windsurf/mcp.json
    • VS Code: .vscode/mcp.json
    • Claude Code: .claude/mcp.json
    {
    "mcpServers": {
        "neo-docs": {
            "url": "https://neo.tvk.company/mcp"
        }
    }
}
  2. Enable the MCP server - The process varies by IDE, but generally:
    • Look for a popup asking you to enable the newly detected MCP server
    • If no popup appears, check your IDE settings for “Tools & MCP” or similar and enable it there
    • If neither option is available, restart your IDE to load the MCP server
Per-project installation keeps configurations isolated to individual projects, reducing potential conflicts and optimizing LLM performance by limiting context to what’s necessary for each project.

​
Benefits

With the Neo Docs MCP server enabled, your AI assistant can:
  • Reference accurate documentation - Access the latest Neo widget properties, enums, and usage examples
  • Provide context-aware suggestions - Understand Neo’s design patterns and recommend appropriate widgets
  • Follow best practices - Suggest code that aligns with Neo’s conventions and guidelines
  • Stay up-to-date - Automatically access documentation updates without manual configuration

​
Usage

Once configured, your AI assistant can reference Neo’s documentation to help you build with Neo. You can ask questions, request code creation, or even build complete screens.

​
Asking Questions

Ask questions about Neo’s widgets, theming, and best practices:
  • “How do I create a NeoTextField with validation?”
  • “What properties are available on NeoButton?”
  • “Show me how to implement dark mode theming in Neo”

​
Creating Widgets and Components

Tell your AI assistant to create specific Neo widgets with your requirements:
  • “Add a NeoButton here that says ‘Save’ and calls the onSave function when pressed”
  • “Create a NeoTable for this user data showing columns for name, email, and role”
  • “Add a NeoTextField with a label ‘Search’ and an icon on the left”
  • “Create a NeoModal with a form for editing user details”

​
Building Complete Screens

Request complete screen implementations:
  • “Create a user settings screen with a form using NeoTextField, NeoDropdownField, and NeoButton”
  • “Build a dashboard screen with a NeoTable showing recent orders and a card with statistics”
  • “Create a login screen with email and password fields using Neo’s form components”

​
Handling Breaking Changes

When Neo releases updates with breaking changes, your AI assistant can automatically migrate your codebase. Since the MCP server has access to release notes with migration instructions, you can simply ask:
  • “Update my codebase to work with the latest Neo version” or “Migrate my code to Neo 2.0”
Your AI assistant will read the release notes, identify all breaking changes and their migration paths, collect the necessary files that need to be updated, and apply all the required changes across your codebase automatically.

​
Troubleshooting

If the MCP server isn’t working:
  1. Verify the configuration - Ensure the JSON syntax is correct and the URL is properly formatted
  2. Check file location - Confirm the mcp.json file is in the correct location within your project root:
    • Cursor: .cursor/mcp.json
    • Windsurf: .windsurf/mcp.json
    • VS Code: .vscode/mcp.json
    • Claude Code: .claude/mcp.json
  3. Restart your IDE - A restart is required after adding or modifying MCP server configurations
  4. Check IDE logs - Review your IDE’s logs for any MCP-related error messages