MCP Nhost

🚀 mcp-nhost

An implementation of the Model Context Protocol (MCP) server for interacting with Nhost cloud projects and services.

🚀 Quick Start

MCP-Nhost aims to provide a unified interface for managing Nhost cloud projects through the Model Context Protocol. It enables you to seamlessly interact with Nhost cloud services and offers a powerful set of tools for project management and configuration.

✨ Features

Available Tools

The following tools are currently exposed through the MCP interface:

1. cloud_get_graphql_schema

   • Provides the GraphQL schema of the Nhost cloud platform.
   • Allows you to access queries and mutations for cloud management.
   • Obtains information about available queries and mutations.

2. cloud_graphql_query

   • Executes GraphQL queries and mutations against the Nhost cloud platform.
   • Implements project and organization management.
   • Allows querying and updating project configurations.
   • Mutations need to be enabled when starting the server.

3. local_get_graphql_schema

   • Retrieves the GraphQL schema of a local Nhost development project.
   • Enables you to access project-specific queries and mutations.
   • Helps generate code to understand available operations.
   • Uses the "user" role by default, unless otherwise specified.

4. local_graphql_query

   • Executes GraphQL queries against a local Nhost development project.
   • Allows you to test and develop project-specific operations.
   • Supports query and mutation operations.
   • Uses the "user" role by default, unless otherwise specified.

5. local_get_possible_query mutations

   • Gets information about available queries and mutations.
   • Displays query and mutation options for the current project.
   • Helps you understand project functionality.
   • Provides clear and structured output.

📦 Installation

To install mcp-nhost, run the following commands:

git clone https://github.com/your-username/mcp-nhost.git
cd mcp-nhost
cargo install --path .

📚 Documentation

Configuration

In the config.toml file, you can specify allowed queries and mutations. For example:

[[projects]]
subdomain = "my-blog"
region = "eu-central-1"
pat = "your_project_access_token"
allow_queries = ["getPost", "getComments"]
allow_mutations = ["insertPost", "insertComment"]

Client Configuration

For Cursor, add the following to config.toml:

[["projects"]]
  subdomain = "my-blog"
  region = "eu-central-1"
  pat = "your_project_access_token"
  allow_queries = ["getPost", "getComments"]
  allow_mutations = ["insertPost", "insertComment"]

CLI Usage

Run the following command to see how to use the CLI:

mcp-nhost --help

🚧 Roadmap

Completed Features

• Security protection layer
• Fine-grained access control
• Project configuration support

Planned Features

• Support for more cloud providers
• Enhanced error handling
• Automated documentation generation

If you have any suggestions or feature requests, feel free to open an issue for discussion.

🔒 Security and Privacy

Enhanced Protection Layer

The MCP server is designed with security in mind, providing an additional layer of protection beyond existing GraphQL permissions. Key security features include:

• Mandatory authentication for all requests.
• Respect for roles and permissions based on your existing authorization system and provided credentials.
• Query/mutation filtering to further restrict allowed operations.

Fine-grained Access Control

A key security advantage of the MCP server is the ability to precisely specify allowed operations, even for users with broader project permissions:

[[projects]]
subdomain = "my-blog"
region = "eu-central-1"
pat = "nhp_project_specific_pat"
allow_queries = ["getBlogs", "getComments"]
allow_mutations = ["insertBlog", "insertComment"]

With the above configuration, the LLM can only execute specified queries and mutations when the user has broader permissions.

🤝 Contribution

We welcome contributions to mcp-nhost! If you have any suggestions, issue reports, or feature requests, feel free to open an issue or submit a pull request.

Thank you for your support and collaboration!