OpenParable
Skip to content
← Back to skills

Evernote SDK Patterns

Development
evernote-sdk-patterns

Evernote SDK Patterns is an Agent Skill for development published in the jeremylongshore/claude-code-plugins-plus-skills repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Advanced Evernote SDK patterns and best practices. Use when implementing complex note operations, batch processing, search queries, or optimizing SDK usage. Trigger with phrases like "evernote sdk patterns", "evernote best practices", "evernote advanced", "evernote batch operations".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/jeremylongshore/claude-code-plugins-plus-skills/blob/HEAD/plugins/saas-packs/evernote-pack/skills/evernote-sdk-patterns/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/evernote-sdk-patterns, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Evernote SDK Patterns

Overview

Production-ready patterns for working with the Evernote SDK, including search with NoteFilter, pagination, attachments, tags, error handling wrappers, and batch operations with rate limit handling.

Prerequisites

  • Completed evernote-install-auth and evernote-hello-world
  • Understanding of Evernote data model (Notes, Notebooks, Tags, Resources)
  • Familiarity with async/await and Promises

Instructions

Pattern 1: Search with NoteFilter

Use NoteFilter for query terms and sort order, paired with NotesMetadataResultSpec to select returned fields. This avoids fetching full note content when only metadata is needed.

const filter = new Evernote.NoteStore.NoteFilter({
  words: 'tag:important notebook:Work',
  ascending: false,
  order: Evernote.Types.NoteSortOrder.UPDATED
});

const spec = new Evernote.NoteStore.NotesMetadataResultSpec({
  includeTitle: true, includeUpdated: true,
  includeTagGuids: true, includeNotebookGuid: true
});

const result = await noteStore.findNotesMetadata(filter, 0, 100, spec);

Pattern 2: Creating Notes with Attachments

Compute the MD5 hash of the file buffer, create a Resource with the binary data and MIME type, embed it in ENML with <en-media type="..." hash="..."/>, and attach it to the note.

const hash = crypto.createHash('md5').update(fileBuffer).digest('hex');
const resource = new Evernote.Types.Resource();
resource.data = new Evernote.Types.Data();
resource.data.body = fileBuffer;
resource.mime = 'image/png';

const note = new Evernote.Types.Note();
note.title = 'Note with Attachment';
note.content = wrapInENML(`<en-media type="image/png" hash="${hash}"/>`);
note.resources = [resource];
await noteStore.createNote(note);

Pattern 3: Error Handling Wrapper

Wrap API calls to distinguish EDAMUserException (client errors), EDAMSystemException (rate limits, maintenance), and EDAMNotFoundException (invalid GUIDs). Use error.rateLimitDuration for automatic retry delays.

Pattern 4: Batch Operations

Process items sequentially with configurable delay between operations. On rate limit errors, wait for rateLimitDuration seconds then retry. Track progress with callbacks.

Pattern 5: Tag and Notebook Management

Implement getOrCreateTag() and getOrCreateNotebook() for idempotent operations. Use listTags() / listNotebooks() to check existence before creating.

For all nine patterns with complete implementations, see Implementation Guide.

Output

  • Search patterns using NoteFilter and NotesMetadataResultSpec
  • Async generator for paginated note retrieval
  • Attachment creation with MD5 hash and MIME type
  • Tag and notebook find-or-create utilities
  • EvernoteError wrapper class with isRateLimit, isNotFound, isInvalidData
  • Batch processor with rate limit retry and progress tracking

Error Handling

ErrorCauseSolution
RATE_LIMIT_REACHEDToo many API callsUse rateLimitDuration, add delays between batch items
BAD_DATA_FORMATInvalid ENMLValidate with wrapInENML() before sending
DATA_CONFLICTConcurrent modificationRefetch note metadata and retry update
QUOTA_REACHEDAccount storage fullCheck remaining quota via user.accounting

Resources

Next Steps

See evernote-core-workflow-a for note creation and management workflows.

Examples

Bulk tagging: Search for all notes matching a query, then batch-add a tag to each result with 200ms delay between operations and automatic rate limit retry.

Attachment upload: Read a PDF from disk, compute its MD5 hash, create a note with the PDF as an <en-media> resource, and verify the upload via getNote() with withResources: true.