SkillsAdd

smithery.ai

grist-reference

Grist API reference documentation for the grist-mcp-server project.

First seen Apr 13, 2026

Installation

$ npx skills add https://smithery.ai
View on skills.sh ↗ Website ↗

Summary

  • Grist API reference documentation for the grist-mcp-server project.
  • Use when implementing or modifying Grist MCP tools, working with Grist cell values, UserActions, column types, widget options, database schema, or pages/widgets.
  • This skill provides authoritative API specifications.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

xlsx Shared topics
anthropics/skills

Use this skill any time a spreadsheet file is the primary input or output. This means any task …

165K installs
clerk-setup Shared topics
clerk/skills 42.6K installs
microsoft-code-reference Similar name
github/awesome-copilot

Look up Microsoft API references, find working code samples, and verify SDK code is correct. Us…

14K installs
wan-3-0-prime-reference-to-video Similar name
genmedia-labs/skills

Build video clips from reference images, reference videos, and reference audio with Wan-AI Wan …

58K installs
seedance-2-5-reference-to-video Similar name
genmedia-labs/skills

Generate reference-guided 1080p video with ByteDance Seedance 2.5 Reference to Video on RunComf…

57.8K installs
reference-list-builder Similar name
paramchoudhary/resumeskills

Format professional references properly and prepare reference materials

7K installs

Also in this package

Other skills from smithery.ai · top by installs.

npx skills add https://smithery.ai
smithery-ai-cli 7.8K frontend-design 6.2K skill-creator 2.5K ck:ui-ux-pro-max 1.3K pdf 1.2K xlsx 966 pptx 894 docx 884 webapp-testing 1 web-design-reviewer 657

Browse all from smithery.ai

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,223 B
  • docs SUMMARY.md 306 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Grist API Reference

This skill provides comprehensive Grist API documentation for developing the grist-mcp-server.

Quick Reference

Task Reference File
REST API endpoints grist-api.yml
TypeScript types, CellValue encoding grist-api.d.ts
Metadata tables, column definitions grist-database-schema.md
Pages, widgets, layouts, linking grist-pages-widgets.md
Apply endpoint, response verification grist-apply-endpoint.md

Reference Files

grist-api.yml (~2100 lines)

OpenAPI 3.0 specification for the Grist REST API.

Grep patterns:

  • paths: - API endpoints
  • components/schemas - Data schemas
  • CellValue - Cell value encoding
  • UserAction - User action format

Use for: Endpoint parameters, request/response schemas, authentication

grist-api.d.ts (~2030 lines)

Complete TypeScript type definitions for Grist API.

Grep patterns:

  • type.*Value - Cell value types (RefValue, DateValue, etc.)
  • interface.*Options - Widget options interfaces
  • UserAction - UserAction type definitions
  • GristObjCode - Encoding codes (L, D, R, etc.)
  • PERMISSION - Permission system reference

Use for: Type definitions, cell value encoding, widget options format

grist-database-schema.md (~573 lines)

Grist metadata tables and database structure.

Key sections:

  • gristTables - Table definitions
  • gristTables_column - Column schema
  • gristViews_section - Widget definitions
  • gristACLRules - Access control

Use for: Understanding metadata structure, foreign key relationships

grist-pages-widgets.md (~658 lines)

Practical guide for pages (views) and widgets (view sections).

Key sections:

  • CreateViewSection - Widget creation action
  • Layout Structure - layoutSpec JSON format
  • Widget Linking - linkSrcSectionRef, linkSrcColRef
  • Sorting - sortColRefs format
  • Filtering - gristFilters table

Use for: Page/widget creation, layout configuration, widget linking

grist-apply-endpoint.md (~490 lines)

Guide for verifying actions via /apply endpoint.

Key sections:

  • ApplyUAResult - Response structure
  • retValues - Return value verification
  • Error Handling - Error response formats
  • Best Practices - Safe access patterns

Use for: Validating action results, error handling patterns

Common Tasks

Implementing a new tool:

  1. Load grist-api.yml for endpoint schema
  2. Load grist-api.d.ts for TypeScript types

Working with cell values:

  1. Load grist-api.d.ts - search for GristObjCode and CellValue

Creating pages/widgets:

  1. Load grist-pages-widgets.md for CreateViewSection and layout format

Understanding metadata tables:

  1. Load grist-database-schema.md for table schemas

Handling apply endpoint responses:

  1. Load grist-apply-endpoint.md for response verification