🚀 项目规范

本项目规范涵盖了项目的安装、启动、调试、工具使用等多方面内容，为开发者提供了清晰的操作指引，确保项目的顺利开发与部署。

🚀 快速开始

安装依赖

pnpm install

开发环境启动

pnpm run dev

构建服务

pnpm run build

启动构建后的服务

pnpm start

📦 安装指南

快速安装

npm install -g @modelcontextprotocol/servers

创建新项目

mcp init

按照提示回答问题，然后运行：

cd your_project_name && pnpm install

启动项目

pnpm run dev

💻 使用示例

调试工具

使用MCP inspector进行调试：

npx @modelcontextprotocol/inspector -e SANITY_API_TOKEN=<token> -e SANITY_PROJECT_ID=<project_id> -e SANITY_DATASET=<ds> -e MCP_USER_ROLE=developer node path/to/build/index.js

此命令提供一个Web界面，用于 inspect 和测试可用工具。

工具使用

基础用法

在项目根目录运行：

npx mcp

输入 help 查看可用命令。

高级用法

• 获取所有数据：

  npx mcp get-all-data
  

• 搜索内容：

  npx mcp search --query "apple"
  

• 创建新文档：

  npx mcp create-document --collection blog_posts --title "My First Blog Post" 
  

📚 详细文档

环境配置

创建一个 .env 文件，并添加以下内容：

SANITY_PROJECT_ID=your_project_id
SANITY_API_TOKEN=your_api_token
SANITY_DATASET=your_dataset_name
MCP_USER_ROLE=developer  # 或 editor

配置文件示例

# .env
SANITY_PROJECT_ID=abc123
SANITY_API_TOKEN=sk-xyz789
SANITY_DATASET=MyProjectDataset
MCP_USER_ROLE=developer

环境变量参考

安全指南

环境变量管理

• 使用 .env 文件存储敏感信息。
• 避免将环境变量直接写入代码。
• 在版本控制中忽略 .env 文件。

密钥安全

• 生成短且随机的API密钥。
• 定期更换密钥。
• 使用 HTTPS 传输数据。

权限管理

• 根据需要设置数据集权限。
• 定期审查项目权限。
• 使用最小权限原则。

其他资源

• 官方文档
• 示例项目
• 社区支持