Skip to main content
Glama
feuerdev
by feuerdev

pin_note

Change the pinned status of a note to keep important notes accessible at the top of your list.

Instructions

Pin or unpin a note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
note_idYes
pinnedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The pin_note tool handler function: retrieves the note, validates it is modifiable, sets pinned status, syncs, and returns serialized note.
    @mcp.tool()
    def pin_note(note_id: str, pinned: bool = True) -> str:
        """Pin or unpin a note."""
        keep, note = _get_note_or_raise(note_id)
        _ensure_modifiable(note)
    
        note.pinned = pinned
        keep.sync()
        return json.dumps(serialize_note(note))
  • Registration via @mcp.tool() decorator on the pin_note function, making it an MCP tool named 'pin_note'.
    @mcp.tool()
  • Schema/parameters: note_id (str, required) and pinned (bool, default True) define the input contract.
    def pin_note(note_id: str, pinned: bool = True) -> str:
  • The serialize_note helper function used by pin_note to convert the note object into a JSON-serializable dict (including the 'pinned' field).
    def serialize_note(note):
        """
        Serialize a Google Keep note into a dictionary.
        
        Args:
            note: A Google Keep note object
            
        Returns:
            dict: A dictionary containing the note's id, title, text, pinned status, color and labels
        """
        payload = {
            'id': note.id,
            'title': note.title,
            'text': note.text,
            'type': note.type.value,
            'pinned': note.pinned,
            'archived': note.archived,
            'trashed': note.trashed,
            'color': note.color.value if note.color else None,
            'labels': [serialize_label(label) for label in note.labels.all()],
            'collaborators': list(note.collaborators.all()),
        }
    
        if hasattr(note, 'items'):
            payload['items'] = [serialize_list_item(item) for item in note.items]
    
        payload['media'] = [
            {
                'blob_id': blob.id,
                'type': blob.blob.type.value if blob.blob and blob.blob.type else None,
            }
            for blob in note.blobs
        ]
    
        return payload
  • The _get_note_or_raise helper used to fetch the note by ID or raise an error.
    def _get_note_or_raise(note_id: str):
        keep = get_client()
        note = keep.get(note_id)
        if not note:
            raise ValueError(f"Note with ID {note_id} not found")
        return keep, note
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are present, so the description bears full responsibility for disclosing behavior. It states 'Pin or unpin' but does not explain consequences (e.g., visibility changes, ordering) or any side effects. The toggling behavior is implied by the 'pinned' parameter, but not explicitly described.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, which is concise but lacks necessary information about parameters and behavior. It is under-specified rather than appropriately sized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple toggle action but low schema coverage and presence of an output schema, the description should at least indicate what is returned or how pinning affects the note. It does not, leaving the tool incomplete in context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% (no descriptions in input schema). The description does not provide any additional meaning for the 'note_id' or 'pinned' parameters. It fails to compensate for the lack of schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Pin or unpin a note' clearly identifies the action (pin/unpin) and resource (note). It is specific and distinguishes from sibling tools like archive_note or trash_note, though it does not elaborate on what pinning means.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives such as archive_note or add_label_to_note. The description does not provide context or prerequisites for pinning.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/feuerdev/keep-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server