Skip to content

evias/go-faru-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fluado/go-faru

A golang MCP server implementation for fluado/faru's git-native kanban boards. This implementation exports MCP Tools that may be used to create, manage and view boards managed with fluado/faru. Output of the MCP tools are formatted using Markdown.

Note: This source code is aimed at enabling AI agents (or LLMs) to interact with tasks and milestones of projects managed with fluado/faru.

Configuration

The MCP server accepts environment variables to overwrite runtime variables:

  • FARU_MCP_HOST: Bind the MCP server to a custom network interface, e.g. 127.0.0.1, defaults to empty.
  • FARU_MCP_PORT: Bind the MCP server to a custom network port, defaults to 8008.
  • FARU_STORAGE_PATH: Filesystem path to the faru files and folders, defaults to $HOME/.faru/.
  • FARU_GIT_UPSTREAM: URL or filesystem path to the upstream committed to by faru, defaults to empty.
  • FARU_GIT_BRANCH: Branch name to keep faru-related commits on a specific branch or worktree.

Defaults

  • FARU_MCP_HOST binds to all network interfaces, meaning the MCP server is accessible using localhost:8008 but also remotely (in case firewall allows it).
  • FARU_MCP_PORT defaults to 8008.
  • FARU_STORAGE_PATH defaults in the user's home directory, i.e. $HOME/.faru/.
  • When FARU_GIT_UPSTREAM is left empty (default), a new repository is created.
  • FARU_GIT_BRANCH defaults to main.

Quick start

  1. Build the source code
make
sudo make install

# Cross-platform build example
GOOS=linux GOARCH=amd64 go build -o faru-mcp-tools-linux
GOOS=linux GOARCH=arm64 go build -o faru-mcp-tools-raspi
GOOS=darwin GOARCH=amd64 go build -o faru-mcp-tools-macos
GOOS=windows GOARCH=amd64 go build -o faru-mcp-tools-win

Alternatively, a Makefile is provided with make and make install targets. Note that the install target requires sudo/root access to copy the executable binary file in your /usr/local/bin.

  1. Start the MCP server (optionally set environment variables)
# Uses default MCP server port 8000
./faru-mcp-tools

# OR passing custom MCP server port configuration:
FARU_MCP_PORT=8008 ./faru-mcp-tools

Packages

  • fluado/go-faru/pkg: exports FaruManager, a golang API for faru.
  • fluado/go-faru/mcp: exports MCP Tools to enable in MCP servers.

License

Copyright (c) 2026 Grégory Saive greg@evi.as for fluado (https://fluado.com).

Licensed under the MIT License.

About

Golang API and MCP Server for fluado/faru git-native kanban board.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors