Skip to content

api_reference.md

Latest commit

 

History

History
1301 lines (946 loc) · 32.2 KB

api_reference.md

File metadata and controls

1301 lines (946 loc) · 32.2 KB

MIST API Reference

This document provides comprehensive documentation for all APIs available in the MIST (Model Intelligence System for Tasks) server.

Note Management API

add_note

Creates a new note with title, content, and optional metadata.

Parameters:

  • title (string, required): The title of the note
  • content (string, required): The main content of the note
  • subject (string, optional): The subject or category of the note

Returns:

  • Success message with the created note ID

Example:

add_note(
    title="Meeting Notes",
    content="Discussed project timeline and assigned tasks to team members.",
    subject="Work"
)

read_note

Retrieves a note by its ID or title.

Parameters:

  • note_id (string, optional): The unique identifier of the note
  • title (string, optional): The title of the note

Either note_id or title must be provided.

Returns:

  • The full content of the note if found
  • Error message if the note doesn't exist

Example:

read_note(note_id="2023-10-15-meeting-notes-1697392485")
# or
read_note(title="Meeting Notes")

list_notes

Lists notes, optionally filtered by subject or tag.

Parameters:

  • subject (string, optional): Filter notes by this subject
  • tag (string, optional): Filter notes by this tag
  • limit (integer, optional): Maximum number of notes to return (default: 10)

Returns:

  • A formatted list of notes matching the criteria

Example:

list_notes(subject="Work", limit=5)

search_notes

Searches notes for specific content or tags.

Parameters:

  • query (string, required): The search query (can be text or a tag with # prefix)

Returns:

  • A list of notes matching the search query

Example:

search_notes(query="project timeline")
# or search for tags
search_notes(query="#project")

edit_note

Updates the content of an existing note.

Parameters:

  • note_id (string, required): The ID of the note to edit
  • new_content (string, required): The new content for the note

Returns:

  • Success message if the note was updated
  • Error message if the note doesn't exist

Example:

edit_note(
    note_id="2023-10-15-meeting-notes-1697392485",
    new_content="Updated meeting notes with action items."
)

delete_note

Deletes a note by its ID.

Parameters:

  • note_id (string, required): The ID of the note to delete

Returns:

  • Success message if the note was deleted
  • Error message if the note doesn't exist

Example:

delete_note(note_id="2023-10-15-meeting-notes-1697392485")

generate_note_summary

Generates a summary of a note by extracting key points.

Parameters:

  • note_id (string, optional): The ID of the note to summarize
  • title (string, optional): The title of the note to summarize

Either note_id or title must be provided.

Returns:

  • A summary of the note with key topics and points

Example:

generate_note_summary(note_id="2023-10-15-meeting-notes-1697392485")

organize_notes_by_subject

Creates a summary of notes organized by subject.

Parameters:

  • None

Returns:

  • A hierarchical organization of notes grouped by subject

Example:

organize_notes_by_subject()

Gmail API

get_emails

Retrieves emails by their IDs.

Parameters:

  • message_ids (list of strings, required): List of email message IDs to retrieve

Returns:

  • Formatted content of all requested emails

Example:

get_emails(message_ids=["183b8e73a1c75d34", "183b8e7c132fda5b"])

search_emails

Searches for emails using specific search criteria.

Parameters:

  • from_email (string, optional): Filter by sender email
  • to_email (string, optional): Filter by recipient email
  • subject (string, optional): Filter by subject text
  • has_attachment (boolean, optional): Filter for emails with attachments
  • is_unread (boolean, optional): Filter for unread emails
  • after_date (string, optional): Filter for emails after this date (format: YYYY/MM/DD)
  • before_date (string, optional): Filter for emails before this date (format: YYYY/MM/DD)
  • label (string, optional): Filter by Gmail label
  • max_results (integer, optional): Maximum number of results (default: 10)

Returns:

  • List of matching emails with preview information

Example:

search_emails(
    from_email="sender@example.com",
    subject="Project Update",
    is_unread=True,
    max_results=5
)

query_emails

Searches for emails using a raw Gmail query string.

Parameters:

  • query (string, required): Gmail search query
  • max_results (integer, optional): Maximum number of results (default: 10)

Returns:

  • List of matching emails with preview information

Example:

query_emails(query="subject:(meeting) is:unread", max_results=5)

send_email

Composes and sends an email.

Parameters:

  • to (string, required): Recipient email address
  • subject (string, required): Email subject
  • body (string, required): Email body content
  • cc (string, optional): Carbon copy recipients
  • bcc (string, optional): Blind carbon copy recipients

Returns:

  • Confirmation message with the sent email details

Example:

send_email(
    to="recipient@example.com",
    subject="Meeting Invitation",
    body="Hello, I'd like to schedule a meeting to discuss our project.",
    cc="manager@example.com"
)

compose_email

Creates a new email draft.

Parameters:

  • to (string, required): Recipient email address
  • subject (string, required): Email subject
  • body (string, required): Email body content
  • cc (string, optional): Carbon copy recipients
  • bcc (string, optional): Blind carbon copy recipients

Returns:

  • Confirmation with draft ID and details

Example:

compose_email(
    to="recipient@example.com",
    subject="Draft: Project Proposal",
    body="Here's the draft of the project proposal we discussed."
)

list_available_labels

Gets all available Gmail labels for the user.

Parameters:

  • None

Returns:

  • Formatted list of labels with their IDs

Example:

list_available_labels()

mark_message_read

Marks a message as read.

Parameters:

  • message_id (string, required): The Gmail message ID to mark as read

Returns:

  • Confirmation message

Example:

mark_message_read(message_id="183b8e73a1c75d34")

add_label_to_message

Adds a label to a message.

Parameters:

  • message_id (string, required): The Gmail message ID
  • label_id (string, required): The Gmail label ID to add

Returns:

  • Confirmation message

Example:

add_label_to_message(
    message_id="183b8e73a1c75d34", 
    label_id="IMPORTANT"
)

remove_label_from_message

Removes a label from a message.

Parameters:

  • message_id (string, required): The Gmail message ID
  • label_id (string, required): The Gmail label ID to remove

Returns:

  • Confirmation message

Example:

remove_label_from_message(
    message_id="183b8e73a1c75d34", 
    label_id="IMPORTANT"
)

Calendar API

list_calendars_tool

Lists all calendars available to the user.

Parameters:

  • None

Returns:

  • Formatted string with all calendars and their IDs

Example:

list_calendars_tool()

create_event_tool

Creates a new event in a specified calendar.

Parameters:

  • calendar_id (string, required): ID of the calendar
  • title (string, required): Title of the event
  • start_datetime (string, required): Start time in RFC3339 format (e.g., "2023-06-03T10:00:00-07:00")
  • end_datetime (string, required): End time in RFC3339 format
  • description (string, optional): Event description
  • location (string, optional): Event location
  • attendees (list of strings, optional): List of attendee email addresses
  • timezone (string, optional): Timezone for the event

Returns:

  • Confirmation message with event details

Example:

create_event_tool(
    calendar_id="primary",
    title="Team Meeting",
    start_datetime="2023-10-20T14:00:00-07:00",
    end_datetime="2023-10-20T15:00:00-07:00",
    description="Weekly team sync",
    location="Conference Room A",
    attendees=["team@example.com"]
)

update_event_tool

Updates an existing calendar event.

Parameters:

  • calendar_id (string, required): ID of the calendar containing the event
  • event_id (string, required): ID of the event to update
  • title (string, optional): New title of the event
  • start_datetime (string, optional): New start time in RFC3339 format
  • end_datetime (string, optional): New end time in RFC3339 format
  • description (string, optional): New event description
  • location (string, optional): New event location

Returns:

  • Confirmation message with updated event details

Example:

update_event_tool(
    calendar_id="primary",
    event_id="abc123xyz",
    title="Updated Team Meeting",
    location="Conference Room B"
)

delete_event_tool

Deletes a calendar event.

Parameters:

  • calendar_id (string, required): ID of the calendar containing the event
  • event_id (string, required): ID of the event to delete

Returns:

  • Confirmation message

Example:

delete_event_tool(
    calendar_id="primary",
    event_id="abc123xyz"
)

search_events_tool

Searches for events in a calendar.

Parameters:

  • calendar_id (string, required): ID of the calendar to search in
  • query (string, required): Search terms to find events
  • max_results (integer, optional): Maximum number of events to return (default: 10)
  • time_min (string, optional): Start time in RFC3339 format
  • time_max (string, optional): End time in RFC3339 format

Returns:

  • Formatted list of matching events

Example:

search_events_tool(
    calendar_id="primary",
    query="meeting",
    max_results=5
)

Tasks API

list_task_lists_tool

Lists all task lists available to the user.

Parameters:

  • None

Returns:

  • Formatted string with all task lists

Example:

list_task_lists_tool()

create_task_tool

Creates a new task in a specified task list.

Parameters:

  • task_list_id (string, required): ID of the task list
  • title (string, required): Title of the new task
  • notes (string, optional): Additional notes for the task
  • due (string, optional): Due date for the task in RFC 3339 format

Returns:

  • Confirmation message with task details

Example:

create_task_tool(
    task_list_id="MDAxOTg4NTI1NTIyMjM4OTU5NDI6MDow",
    title="Complete project documentation",
    notes="Include API reference and setup guide",
    due="2023-10-31T00:00:00Z"
)

update_task_tool

Updates an existing task.

Parameters:

  • task_list_id (string, required): ID of the task list
  • task_id (string, required): ID of the task to update
  • title (string, optional): New title for the task
  • notes (string, optional): New notes for the task
  • due (string, optional): New due date for the task in RFC 3339 format

Returns:

  • Confirmation message with updated task details

Example:

update_task_tool(
    task_list_id="MDAxOTg4NTI1NTIyMjM4OTU5NDI6MDow",
    task_id="MDAyMDM4NTI1NTIyMjM4OTU5NDI6MDow",
    notes="Added more details to documentation task"
)

complete_task_tool

Marks a task as completed.

Parameters:

  • task_list_id (string, required): ID of the task list
  • task_id (string, required): ID of the task to complete

Returns:

  • Confirmation message

Example:

complete_task_tool(
    task_list_id="MDAxOTg4NTI1NTIyMjM4OTU5NDI6MDow",
    task_id="MDAyMDM4NTI1NTIyMjM4OTU5NDI6MDow"
)

delete_task_tool

Deletes a task.

Parameters:

  • task_list_id (string, required): ID of the task list
  • task_id (string, required): ID of the task to delete

Returns:

  • Confirmation message

Example:

delete_task_tool(
    task_list_id="MDAxOTg4NTI1NTIyMjM4OTU5NDI6MDow",
    task_id="MDAyMDM4NTI1NTIyMjM4OTU5NDI6MDow"
)

create_task_list_tool

Creates a new task list.

Parameters:

  • title (string, required): Title of the new task list

Returns:

  • Confirmation message with task list details

Example:

create_task_list_tool(title="Work Projects")

delete_task_list_tool

Deletes a task list.

Parameters:

  • task_list_id (string, required): ID of the task list to delete

Returns:

  • Confirmation message

Example:

delete_task_list_tool(task_list_id="MDAxOTg4NTI1NTIyMjM4OTU5NDI6MDow")

Git API

status_tool

Shows the working tree status of a Git repository.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted string with the repository status

Example:

status_tool(repo_path="/path/to/repository")

diff_unstaged_tool

Shows changes in the working directory that are not yet staged.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted string with unstaged changes

Example:

diff_unstaged_tool(repo_path="/path/to/repository")

diff_staged_tool

Shows changes that are staged for commit.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted string with staged changes

Example:

diff_staged_tool(repo_path="/path/to/repository")

diff_tool

Shows differences between branches or commits.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • target (string, required): Target to compare with (branch name, commit hash, etc.)

Returns:

  • Formatted string with differences

Example:

diff_tool(repo_path="/path/to/repository", target="main")

commit_tool

Records changes to the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • message (string, required): Commit message

Returns:

  • Confirmation message with commit hash

Example:

commit_tool(
    repo_path="/path/to/repository",
    message="Fix bug in login functionality"
)

add_tool

Adds file contents to the staging area.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • files (list of strings, required): List of file paths to add

Returns:

  • Confirmation message

Example:

add_tool(
    repo_path="/path/to/repository",
    files=["file1.txt", "directory/file2.js"]
)

reset_tool

Reset the current HEAD to a specified state, or unstage files from the index.

Parameters:

  • repo_path (string, required): Path to the Git repository.
  • commit_ish (string, optional): The commit to reset to (e.g., 'HEAD~1', a commit hash, a branch name). If not provided and mode is also not 'soft', 'mixed', or 'hard', this command will unstage all changes (equivalent to git reset).
  • mode (string, optional): The reset mode. Can be 'soft', 'mixed', or 'hard'.
    • soft: Resets HEAD to commit_ish but does not touch the index file or the working tree at all. Changes are left as "Changes to be committed".
    • mixed: (Default if commit_ish is provided and mode is not) Resets HEAD and index to commit_ish. Changes in the working directory are preserved but unstaged.
    • hard: Resets HEAD, index, and working directory to commit_ish. All changes to tracked files in the working tree since commit_ish are discarded. If commit_ish is None and mode is None, it unstages all files from the index.

Returns:

  • Confirmation message describing the reset operation.

Example (Unstage all files):

reset_tool(repo_path="/path/to/repository")

Example (Soft reset to previous commit):

reset_tool(repo_path="/path/to/repository", commit_ish="HEAD~1", mode="soft")

Example (Hard reset to a specific commit):

reset_tool(repo_path="/path/to/repository", commit_ish="a1b2c3d", mode="hard")

Example (Mixed reset to main branch):

reset_tool(repo_path="/path/to/repository", commit_ish="main") # mode defaults to 'mixed'

log_tool

Shows the commit logs.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • max_count (integer, optional): Maximum number of commits to show (default: 10)

Returns:

  • Formatted string with commit history

Example:

log_tool(repo_path="/path/to/repository", max_count=5)

create_branch_tool

Creates a new branch from an optional base branch.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • branch_name (string, required): Name of the new branch
  • base_branch (string, optional): Base branch name (default: current branch)

Returns:

  • Confirmation message

Example:

create_branch_tool(
    repo_path="/path/to/repository",
    branch_name="feature/user-authentication",
    base_branch="develop"
)

checkout_tool

Switches branches.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • branch_name (string, required): Name of the branch to checkout

Returns:

  • Confirmation message

Example:

checkout_tool(
    repo_path="/path/to/repository",
    branch_name="feature/user-authentication"
)

show_tool

Shows the contents of a commit.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • revision (string, required): Revision to show (commit hash, branch name, etc.)

Returns:

  • Formatted string with commit details and changes

Example:

show_tool(
    repo_path="/path/to/repository",
    revision="abc123"
)

init_tool

Initializes a new Git repository.

Parameters:

  • repo_path (string, required): Path where the repository should be initialized

Returns:

  • Confirmation message

Example:

init_tool(repo_path="/path/to/new/repository")

branch_list_tool

Lists all branches in the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted string with list of branches

Example:

branch_list_tool(repo_path="/path/to/repository")

remote_list_tool

Lists all remotes for the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted string with list of remotes

Example:

remote_list_tool(repo_path="/path/to/repository")

remote_add_tool

Adds a remote to the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • name (string, required): Name of the remote
  • url (string, required): URL of the remote

Returns:

  • Confirmation message

Example:

remote_add_tool(
    repo_path="/path/to/repository",
    name="origin",
    url="https://github.com/username/repository.git"
)

pull_tool

Pulls changes from a remote.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • remote (string, optional): Name of the remote (default: "origin")
  • branch (string, optional): Branch to pull (default: current branch)

Returns:

  • Pull operation output

Example:

pull_tool(
    repo_path="/path/to/repository",
    remote="origin",
    branch="main"
)

push_tool

Pushes changes to a remote.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • remote (string, optional): Name of the remote (default: "origin")
  • branch (string, optional): Branch to push (default: current branch)
  • force (boolean, optional): Force push even if it results in a non-fast-forward merge (default: False)
  • tags (boolean, optional): Push all tags to the remote (default: False)

Returns:

  • Push operation output

Example:

push_tool(
    repo_path="/path/to/repository",
    remote="origin",
    branch="feature/new-feature",
    force=True
)

cherry_pick_tool

Apply the changes introduced by an existing commit.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • commit_hash (string, required): The commit hash to cherry-pick

Returns:

  • Cherry-pick output as string, indicating success or conflicts.

Example:

cherry_pick_tool(repo_path="/path/to/repository", commit_hash="a1b2c3d")

stash_save_tool

Stash changes in the working directory.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • message (string, optional): Optional message for the stash
  • include_untracked (boolean, optional): Include untracked files in the stash (default: False)

Returns:

  • Stash save output as string.

Example:

stash_save_tool(repo_path="/path/to/repository", message="WIP on feature X", include_untracked=True)

stash_list_tool

List all stashes in the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted list of stashes.

Example:

stash_list_tool(repo_path="/path/to/repository")

stash_apply_tool

Apply a stashed state.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • stash_id (string, optional): Identifier of the stash to apply (e.g., 'stash@{0}'). If None, applies the latest stash.
  • index (boolean, optional): Whether to restore the index state as well (default: False)

Returns:

  • Stash apply output as string, indicating success or conflicts.

Example:

stash_apply_tool(repo_path="/path/to/repository", stash_id="stash@{1}", index=True)

stash_pop_tool

Apply and remove a stashed state.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • stash_id (string, optional): Identifier of the stash to pop (e.g., 'stash@{0}'). If None, pops the latest stash.

Returns:

  • Stash pop output as string, indicating success or conflicts.

Example:

stash_pop_tool(repo_path="/path/to/repository")

stash_drop_tool

Remove a stashed state.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • stash_id (string, optional): Identifier of the stash to drop (e.g., 'stash@{0}'). If None, drops the latest stash.

Returns:

  • Stash drop output as string.

Example:

stash_drop_tool(repo_path="/path/to/repository", stash_id="stash@{2}")

rebase_tool

Rebase the current branch onto another branch or commit, or manage an in-progress rebase.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • branch_or_commit (string, optional): Branch or commit to rebase onto. Required unless abort or continue_rebase is True.
  • interactive (boolean, optional): Start an interactive rebase (default: False)
  • abort (boolean, optional): Abort an in-progress rebase (default: False)
  • continue_rebase (boolean, optional): Continue an in-progress rebase after resolving conflicts (default: False)

Returns:

  • Rebase output as string, indicating success, conflicts, or status.

Example (Start Rebase):

rebase_tool(repo_path="/path/to/repository", branch_or_commit="main", interactive=True)

Example (Continue Rebase):

rebase_tool(repo_path="/path/to/repository", continue_rebase=True)

Example (Abort Rebase):

rebase_tool(repo_path="/path/to/repository", abort=True)

merge_tool

Merge a branch into the current branch, or manage an in-progress merge.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • branch (string, optional): Branch to merge. Required unless abort is True.
  • strategy (string, optional): Merge strategy (e.g., 'recursive', 'resolve', 'octopus', 'ours', 'subtree')
  • commit_message (string, optional): Custom commit message for the merge
  • no_ff (boolean, optional): Create a merge commit even if it's a fast-forward merge (default: False)
  • abort (boolean, optional): Abort an in-progress merge (default: False)

Returns:

  • Merge output as string, indicating success, conflicts, or status.

Example (Merge Branch):

merge_tool(repo_path="/path/to/repository", branch="feature/xyz", strategy="ours", no_ff=True)

Example (Abort Merge):

merge_tool(repo_path="/path/to/repository", abort=True)

tag_create_tool

Create a new tag.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • tag_name (string, required): Name of the tag
  • message (string, optional): Tag message. If provided, creates an annotated tag; otherwise, a lightweight tag.
  • commit (string, optional): Commit to tag (e.g., commit hash, branch name). If not provided, tags the current HEAD.

Returns:

  • Tag creation output as string.

Example:

tag_create_tool(repo_path="/path/to/repository", tag_name="v1.0", message="Version 1.0 Release", commit="main")

tag_list_tool

List all tags in the repository.

Parameters:

  • repo_path (string, required): Path to the Git repository

Returns:

  • Formatted list of tags with their associated commit and message (if annotated).

Example:

tag_list_tool(repo_path="/path/to/repository")

tag_delete_tool

Delete a tag.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • tag_name (string, required): Name of the tag to delete

Returns:

  • Tag deletion output as string.

Example:

tag_delete_tool(repo_path="/path/to/repository", tag_name="v0.9-alpha")

amend_commit_tool

Amend the last commit. Allows changing the commit message and/or adding more changes.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • message (string, optional): New commit message. If not provided and no_edit is False, an editor will typically open.
  • no_edit (boolean, optional): Use the existing commit message without modification (default: False). Cannot be used if message is also provided.

Returns:

  • Amend commit output as string.

Example (New Message):

# (Stage files first using add_tool if you want to add changes)
amend_commit_tool(repo_path="/path/to/repository", message="Fix typo in previous commit message and add newfile.txt")

Example (No Edit):

# (Stage files first using add_tool to add changes with the same message)
amend_commit_tool(repo_path="/path/to/repository", no_edit=True)

blame_tool

Show who last modified each line of a file.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • file_path (string, required): Path to the file within the repository
  • start_line (integer, optional): First line to show (1-based).
  • end_line (integer, optional): Last line to show (1-based). If provided, start_line must also be provided.

Returns:

  • Blame output as string, showing commit hash, author, date, and line content.

Example:

blame_tool(repo_path="/path/to/project", file_path="src/main.py", start_line=10, end_line=20)

branch_delete_tool

Delete a branch.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • branch_name (string, required): Name of the branch to delete
  • force (boolean, optional): Force deletion even if the branch contains unmerged changes (default: False). Use -D equivalent.

Returns:

  • Branch deletion output as string.

Example:

branch_delete_tool(repo_path="/path/to/repository", branch_name="old-feature", force=True)

clean_tool

Remove untracked files from the working tree.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • directories (boolean, optional): Also remove untracked directories (default: False). Equivalent to -d.
  • force (boolean, optional): Force removal. Required if clean.requireForce is not set to false (default: False). Equivalent to -f.
  • dry_run (boolean, optional): Show what would be done without actually removing files (default: True). Equivalent to -n.

Returns:

  • Clean output as string, listing files/directories that would be/were removed.

Example (Dry Run):

clean_tool(repo_path="/path/to/repository", directories=True, dry_run=True)

Example (Actual Clean):

clean_tool(repo_path="/path/to/repository", directories=True, force=True, dry_run=False)

config_get_tool

Get a git configuration value.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • key (string, required): Configuration key (e.g., 'user.name', 'core.editor')
  • global_config (boolean, optional): Get from global config instead of local repository config (default: False)

Returns:

  • Configuration value as string, or a message if the key is not found.

Example:

config_get_tool(repo_path="/path/to/repository", key="user.email")
config_get_tool(repo_path="/path/to/repository", key="user.name", global_config=True)

config_set_tool

Set a git configuration value.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • key (string, required): Configuration key (e.g., 'user.name')
  • value (string, required): Configuration value to set
  • global_config (boolean, optional): Set in global config instead of local repository config (default: False)

Returns:

  • Confirmation message.

Example:

config_set_tool(repo_path="/path/to/repository", key="user.name", value="New User Name")
config_set_tool(repo_path="/path/to/repository", key="alias.st", value="status", global_config=True)

reflog_tool

Show the reference logs (reflog). Reflog records when the tips of branches and other references were updated in the local repository.

Parameters:

  • repo_path (string, required): Path to the Git repository
  • max_count (integer, optional): Maximum number of reflog entries to return (default: 10)

Returns:

  • Formatted reflog output as a string.

Example:

reflog_tool(repo_path="/path/to/repository", max_count=5)

submodule_add_tool

Add a new submodule to the repository.

Parameters:

  • repo_path (string, required): Path to the parent Git repository
  • repository (string, required): URL of the submodule repository to add
  • path (string, required): Path within the parent repository where the submodule should be cloned

Returns:

  • Submodule add output as string.

Example:

submodule_add_tool(repo_path="/path/to/parent-repo", repository="https://github.com/user/sub-repo.git", path="libs/sub-repo")

submodule_update_tool

Update registered submodules to match what the superproject expects. This can initialize, fetch, and checkout submodules.

Parameters:

  • repo_path (string, required): Path to the parent Git repository
  • init (boolean, optional): Initialize uninitialized submodules (i.e., copy submodule URLs from .gitmodules to local .git/config) (default: True).
  • recursive (boolean, optional): Also update nested submodules recursively (default: True).

Returns:

  • Submodule update output as string.

Example:

submodule_update_tool(repo_path="/path/to/parent-repo", init=True, recursive=True)

Resource Endpoints

MIST also provides direct access to resources through MCP resource endpoints:

Note Resources

Currently implemented as tools rather than resources.

Gmail Resources

  • gmail://messages/{message_id}: Get an email message by ID
  • gmail://threads/{thread_id}: Get all messages in an email thread

Calendar Resources

  • calendar://calendars/{calendar_id}/events: Get events from a specific calendar
  • calendar://calendars/{calendar_id}/events/{event_id}: Get details of a specific calendar event

Tasks Resources

  • tasks://lists/{task_list_id}: Get all tasks in a task list
  • tasks://lists/{task_list_id}/tasks/{task_id}: Get details of a specific task

Error Handling

All API functions follow standard error handling patterns:

  1. If a resource is not found (e.g., note, email, event), a clear error message is returned
  2. If parameters are missing or invalid, an error message indicates the issue
  3. If authentication fails, an error describing the authentication problem is returned
  4. If API rate limits are exceeded, an appropriate error is returned

Most errors follow this format:

Error: [Error Type] - [Detailed description]

Pagination

For APIs that return lists of items:

  • Most list operations accept a max_results or limit parameter
  • Default limits are typically 10 items
  • For large result sets, consider using more specific filters