Skip to main content

Unified MCP server for Glyphs handbook and API queries

Project description

English | 繁體中文

Glyphs info MCP

A unified MCP server integrating Glyphs handbook queries and API reference lookups for Glyphs font design software.

🚀 Quick Start

Requirements

  • Python 3.10+
  • uv package manager - MCP officially recommended
  • Claude Desktop - For running the MCP server
  • macOS

Installation

Method 1: Using uvx (Recommended)

Step 1: Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Configure Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "glyphs-info": {
      "command": "uvx",
      "args": ["glyphs-info-mcp"]
    }
  }
}

Restart Claude Desktop and you're ready to go!


Method 2: Install from Source (Developers)

Prerequisites: uv installed (see Method 1 Step 1)

# Clone with submodules
git clone --recursive https://github.com/yintzuyuan/glyphs-info-mcp.git
cd glyphs-info-mcp

# Install dependencies
uv sync

Configure Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "glyphs-info-mcp": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/username/glyphs-info-mcp",
        "run",
        "glyphs-info-mcp"
      ]
    }
  }
}

[!IMPORTANT] Replace /Users/username/glyphs-info-mcp with your actual absolute path.


Verify Installation

uv run glyphs-info-mcp

You should see:

✅ Glyphs info MCP Server initialized with 8 unified tools

✨ Features

  • 🔍 Unified Search - Smart query routing with automatic content type detection
  • 🌏 Multilingual UI Terms - Support for Glyphs UI terminology in 14 languages
  • 📚 Complete Handbook - All Glyphs official handbook content
  • 🔌 Full API Reference - Python and Objective-C API documentation
  • 🧠 Smart Cross-referencing - Automatic linking of related content
  • 🛠️ MCP Protocol Compatible - Standardized tool interface

📋 Feature Overview

Operating Requirements

Module Out-of-box Network Glyphs Required
Handbook First cache build -
API (Python) - -
API (Obj-C Headers) - -
SDK Documentation - -
mekkablue Scripts - -
Light Table API - -
Vocabulary - -
Plugins (Local) - -
Plugins (Official) - -
News/Tutorials - -

[!TIP] Out-of-box: Uses bundled GlyphsSDK submodule data, no extra setup needed. Network: Handbook only needs network for initial cache, then works offline. Glyphs Required: Reads from local Glyphs app (Headers from GlyphsCore.framework).

MCP Tools (8 Unified Entry Points)

The server provides 8 unified tools with action-based routing, reducing context token cost by ~85%:

  • handbook - Glyphs Handbook operations
  • vocabulary - UI terminology translation (14 languages)
  • api - Python and Objective-C API reference
  • plugins - Local and official plugin management
  • scripts - mekkablue script collection (358+)
  • sdk - SDK documentation and Xcode templates
  • news - Forum, tutorials, and news search
  • lighttable - Light Table version control API
Expand full tool list

handbook

Action Description
search Search handbook content
get Get chapter content by filename
toc Get table of contents
children Get chapter children
parameter Get custom parameter details
list_parameters List all custom parameters
cache Cache management (info/update)

vocabulary

Action Description
translate Translate UI term
search Search UI terms
mapping Get multi-locale translations
categories List vocabulary categories

api

Action Description
search_python Search Python API
get_class Get Python class info
get_member Get class member info
search_objc Search Obj-C headers
get_header Get Obj-C header content
list_protocols List plugin protocols
get_protocol Get protocol methods
convert_objc Convert Obj-C to Python name
convert_python Convert Python to Obj-C name
identify_method Identify method type
get_template Get method implementation template
search_vanilla Search Vanilla UI components
get_vanilla Get Vanilla UI component
list_vanilla List all Vanilla UI components
hierarchy Get class hierarchy
relationships Get class relationships
navigate Navigate class structure

plugins

Action Description
search_local Search local plugins
search_official Search official registry
get_info Get plugin details
scan Scan repositories directory
categories List plugin categories

scripts

Action Description
search Search scripts
get Get script details
categories List script categories
list List scripts in category

sdk

Action Description
search Search SDK content
get Get SDK file content
list_templates List Xcode templates
get_template Get Xcode template
list_samples List Xcode samples
get_sample Get Xcode sample

news

Action Description
search_forum Search forum discussions
search_tutorials Search tutorials
fetch_tutorial Fetch tutorial content
fetch_forum Fetch forum post
search_posts Search news posts
fetch_content Fetch news content

lighttable

Action Description
search Search Light Table API
get_enum Get enum details
list_enums List all enums
list_all List all API items

📖 Usage Guide

Usage Examples

# Handbook queries
handbook(action="search", query="kerning")
handbook(action="get", filename="anchors.md")

# API queries
api(action="search_python", query="GSFont")
api(action="get_class", class_name="GSGlyph")

# UI terminology
vocabulary(action="translate", term="Cancel", target="zh-Hant")

Search Best Practices

  • Use core English terminology words
  • Prefer single concept keywords
  • Utilize automatic query type detection
  • Refer to the terminology reference for translations

🛠️ Development

Setup

# Install development dependencies
uv sync --extra dev

# Install test dependencies
uv sync --extra test

Code Quality

uv run black src/ tests/      # Formatting
uv run ruff check src/ --fix  # Linting
uv run mypy src/              # Type checking

Testing

uv run pytest                              # All tests
uv run pytest tests/test_specific.py       # Specific tests
uv run pytest --cov=src/glyphs_info_mcp    # Coverage

📚 Background

Development Approach

This project was largely built using Vibe Coding iterative development, focusing on rapid feature implementation and practicality.

Data Sources

Recommended Model

After testing, this project works best with Claude models. We recommend using it in the Claude Desktop environment for the best experience.

❓ FAQ

Cannot find uv command

Restart your terminal, or run source ~/.zshrc

Claude Desktop cannot load the MCP server
  1. Ensure the path is an absolute path (not relative or using ~)
  2. Check for JSON syntax errors
  3. Restart Claude Desktop
Server fails to start
uv sync --reinstall
python --version  # Requires 3.10+

⚙️ Configuration

Environment Variables

All paths are auto-detected. Only set these if using non-standard locations:

# export GLYPHS_APP_PATH=/Applications/Glyphs 3.app
# export GLYPHS_APP_HEADERS_PATH=/Applications/Glyphs\ 3.app/Contents/Frameworks/GlyphsCore.framework/Versions/A/Headers
# export GLYPHS_REPOSITORIES_PATH=~/Library/Application\ Support/Glyphs\ 3/Repositories

Or use the env field in Claude Desktop configuration:

{
  "mcpServers": {
    "glyphs-info": {
      "command": "uvx",
      "args": ["glyphs-info-mcp"],
      "env": {
        "GLYPHS_APP_PATH": "/Applications/Glyphs 3.app"
      }
    }
  }
}

Module Enable/Disable

By default, all modules are enabled. To control specific modules, use environment variables:

Available modules: vocabulary, handbook, api, glyphs_plugins, glyphs_news, glyphs_sdk, light_table_api, mekkablue_scripts

Whitelist mode (enable only specified modules):

{
  "mcpServers": {
    "glyphs-info": {
      "command": "uvx",
      "args": ["glyphs-info-mcp"],
      "env": {
        "GLYPHS_ENABLED_MODULES": "handbook,api"
      }
    }
  }
}

Blacklist mode (disable specified modules):

{
  "mcpServers": {
    "glyphs-info": {
      "command": "uvx",
      "args": ["glyphs-info-mcp"],
      "env": {
        "GLYPHS_DISABLED_MODULES": "glyphs_news,glyphs_plugins"
      }
    }
  }
}

If both whitelist and blacklist are set, whitelist takes precedence.

🔗 Resources

📄 License

MIT License - see LICENSE file.


Glyphs info MCP - Making Glyphs knowledge queries simple and powerful

Last updated: 2025-12-30

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glyphs_info_mcp-1.2.1.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

glyphs_info_mcp-1.2.1-py3-none-any.whl (7.1 MB view details)

Uploaded Python 3

File details

Details for the file glyphs_info_mcp-1.2.1.tar.gz.

File metadata

  • Download URL: glyphs_info_mcp-1.2.1.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for glyphs_info_mcp-1.2.1.tar.gz
Algorithm Hash digest
SHA256 47ebff0984c30ef2f812eec254e036d8e0b3f52284d982d1e4e56cb109f74714
MD5 fcd5c362aa0777d2470ae7e65632d65c
BLAKE2b-256 7a68f0cfe0c12f8db21e6f2e05089e5c444708d3a67d5551478050c9f8e41301

See more details on using hashes here.

Provenance

The following attestation bundles were made for glyphs_info_mcp-1.2.1.tar.gz:

Publisher: publish.yml on yintzuyuan/glyphs-info-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file glyphs_info_mcp-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for glyphs_info_mcp-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3a7a05b5636eb69b6610a0f1db24b3092ad2eb85e7b9e2c872bf4e59e03e23bb
MD5 00db9c35a46428f68cef9d65928429d8
BLAKE2b-256 4577e689096c2c387039385cf55ab52d6001cfc7f700b0f025b166eddffe0f5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for glyphs_info_mcp-1.2.1-py3-none-any.whl:

Publisher: publish.yml on yintzuyuan/glyphs-info-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page