cursor

Documentation

Overview

Package cursor provides an adapter for Cursor IDE MCP configuration.

Cursor uses the same format as Claude Desktop, with config files at:

• Global: ~/.cursor/mcp.json
• Project: .cursor/mcp.json

Index

• Constants
• func GlobalConfigPath() (string, error)
• func ReadGlobalConfig() (*core.Config, error)
• func WriteGlobalConfig(cfg *core.Config) error
• type Adapter
  • func NewAdapter() *Adapter
  • func (a *Adapter) DefaultPaths() []string
  • func (a *Adapter) Marshal(cfg *core.Config) ([]byte, error)
  • func (a *Adapter) Name() string
  • func (a *Adapter) Parse(data []byte) (*core.Config, error)
  • func (a *Adapter) ReadFile(path string) (*core.Config, error)
  • func (a *Adapter) WriteFile(cfg *core.Config, path string) error
• type Config
  • func NewConfig() *Config
• type ServerConfig

Constants

const (
	// AdapterName is the identifier for this adapter.
	AdapterName = "cursor"

	// GlobalConfigDir is the global config directory name.
	GlobalConfigDir = ".cursor"

	// ConfigFileName is the config file name.
	ConfigFileName = "mcp.json"
)

Functions

func GlobalConfigPath

func GlobalConfigPath() (string, error)

GlobalConfigPath returns the path to the global Cursor config.

func ReadGlobalConfig

func ReadGlobalConfig() (*core.Config, error)

ReadGlobalConfig reads the global ~/.cursor/mcp.json file.

func WriteGlobalConfig

func WriteGlobalConfig(cfg *core.Config) error

WriteGlobalConfig writes to the global ~/.cursor/mcp.json file.

Types

type Adapter

type Adapter struct {
	// contains filtered or unexported fields
}

Adapter implements core.Adapter for Cursor IDE.

func NewAdapter

func NewAdapter() *Adapter

NewAdapter creates a new Cursor adapter.

func (*Adapter) DefaultPaths

func (a *Adapter) DefaultPaths() []string

DefaultPaths returns the default config file paths for Cursor.

func (*Adapter) Marshal

func (a *Adapter) Marshal(cfg *core.Config) ([]byte, error)

Marshal converts canonical config to Cursor format.

func (*Adapter) Name

func (a *Adapter) Name() string

Name returns the adapter name.

func (*Adapter) Parse

func (a *Adapter) Parse(data []byte) (*core.Config, error)

Parse parses Cursor config data into the canonical format.

func (*Adapter) ReadFile

func (a *Adapter) ReadFile(path string) (*core.Config, error)

ReadFile reads a Cursor config file.

func (*Adapter) WriteFile

func (a *Adapter) WriteFile(cfg *core.Config, path string) error

WriteFile writes canonical config to a Cursor format file.

type Config

type Config = claude.Config

Config is an alias for Claude's config since the format is identical.

func NewConfig

func NewConfig() *Config

NewConfig creates a new Cursor config.

type ServerConfig

type ServerConfig = claude.ServerConfig

ServerConfig is an alias for Claude's server config.