Truqu
БесплатноНе проверенEnables querying and managing Truqu goals, feedback, and reflections by loading exported JSON data and providing tools to filter and retrieve them.
Описание
Enables querying and managing Truqu goals, feedback, and reflections by loading exported JSON data and providing tools to filter and retrieve them.
README
A Model Context Protocol (MCP) server for interacting with Truqu goal and feedback data, built with TypeScript.
Getting Started
Step 1: Export your Truqu data
- In Truqu, click on your profile picture (top right corner)
- Select Settings
- Click on Your data
- Download your data as a JSON file
Step 2: Add MCP server to your client
For Claude Desktop:
- Open Claude Desktop settings
- Go to the "Developer" section
- Click "Edit Config" button under "Local MCP servers"
- Edit the config file to add the MCP server:
{
"mcpServers": {
"truqu-mcp": {
"command": "npx",
"args": ["truqu-mcp", "/path/to/your/downloaded-truqu-data.json"]
}
}
}
- Replace
/path/to/your/downloaded-truqu-data.jsonwith the actual path to your Truqu JSON file - Restart Claude Desktop
For other MCP clients:
Run the server directly:
npx truqu-mcp "/path/to/your/downloaded-truqu-data.json"
That's it! The server will start and load your Truqu data automatically.
What is MCP?
The Model Context Protocol (MCP) is an open standard that enables AI applications to securely connect to external data sources and tools. This server provides a foundation for building custom MCP integrations.
Features
- Built with TypeScript for type safety
- Uses the official MCP TypeScript SDK
- Load and parse Truqu JSON data exports
- Filter data by user ownership automatically
- Date range filtering for goals, feedback, and reflections
- Comprehensive goal management tools
- Hot reload during development
- Production-ready build configuration
Prerequisites
- Node.js 18 or higher
- npm or yarn
Installation
Option 1: Use directly with npx (Recommended)
No installation required! Just use the published npm package:
npx truqu-mcp "/path/to/your/truqu-data.json"
Option 2: Local development
- Clone this repository
- Install dependencies:
npm install
Configuration
The server requires a path to your Truqu data JSON file. You can provide this in two ways:
Method 1: Command Line Argument (Recommended)
# Using npm package (recommended)
npx truqu-mcp "/path/to/your/truqu-data.json"
# Local development (alternative)
tsx src/index.ts "/path/to/your/truqu-data.json"
Method 2: Environment Variable
# Using npm package (recommended)
export TRUQU_DATA_PATH="/path/to/your/truqu-data.json"
npx truqu-mcp
# Local development (alternative)
export TRUQU_DATA_PATH="/path/to/your/truqu-data.json"
tsx src/index.ts
Development (Local only)
For local development and contributions:
Start the development server with hot reload:
tsx src/index.ts "/path/to/your/truqu-data.json"
Watch for changes during development:
npm run watch
Building (Local only)
Build the TypeScript code to JavaScript:
npm run build
Project Structure
truqu-mcp/
├── src/
│ └── index.ts # Main server implementation
├── dist/ # Built JavaScript files (after npm run build)
├── package.json # Project configuration and dependencies
├── tsconfig.json # TypeScript configuration
├── .gitignore # Git ignore rules
└── README.md # This file
Available Tools
The server provides tools to interact with Truqu goal and feedback data:
Goals
- get_goals_list: Get a list of user's goals with basic information (id, title, dates, status)
- Parameters:
startDate(optional string),endDate(optional string) - Date filtering in YYYY-MM-DD format
- Parameters:
- get_goals_detailed: Get detailed information about user's goals including action points and items
- Parameters:
startDate(optional string),endDate(optional string) - Date filtering in YYYY-MM-DD format
- Parameters:
- get_goal_by_id: Get a specific goal by its ID
- Parameters:
goalId(required string) - The ID of the goal to retrieve
- Parameters:
Feedback
- get_feedback: Get feedback/reviews given to the user
- Parameters:
startDate(optional string),endDate(optional string) - Date filtering in YYYY-MM-DD format
- Parameters:
Reflections
- get_reflections: Get user's reflection reports
- Parameters:
startDate(optional string),endDate(optional string) - Date filtering in YYYY-MM-DD format
- Parameters:
Usage Example
Once the server is running with your Truqu data configured, you can use these tools:
- Get a list of your goals:
// Get all goals
get_goals_list({});
// Get goals from 2024
get_goals_list({ startDate: "2024-01-01", endDate: "2024-12-31" });
- Get detailed goal information:
// Get detailed info for all goals
get_goals_detailed({});
// Get a specific goal
get_goal_by_id({ goalId: "168a7025-f6cc-41cc-abd7-087467c634ae" });
- Get feedback and reflections:
// Get all feedback
get_feedback({});
// Get reflections from 2025
get_reflections({ startDate: "2025-01-01" });
Data Filtering
- The server automatically filters data to show only items owned by the current user
- Goals are filtered by the
owner.idfield - Reviews are filtered by the
professional.idfield - Reflections are filtered by the
user.idfield - Date filtering uses the
createdfield for goals and reflections, and thedatefield for reviews
Extending the Server
To add new tools:
- Add the tool definition in the
ListToolsRequestSchemahandler - Implement the tool logic in the
CallToolRequestSchemahandler - Update this README with documentation for your new tools
MCP Client Configuration
To use this server with an MCP client, you have several options:
Option 1: Using npm package (Recommended)
Run the server directly from npm:
npx truqu-mcp "/path/to/your/truqu-data.json"
Option 2: Local development
For local development and testing:
npx tsx src/index.ts "/path/to/your/truqu-data.json"
Client Configuration
Configure your MCP client with one of these approaches:
Using npm package (Recommended):
- Command:
npx truqu-mcp "/path/to/your/truqu-data.json" - No working directory required
Local development:
- Command:
npx tsx src/index.ts "/path/to/your/truqu-data.json" - Working directory:
/path/to/truqu-mcp
Example Claude Desktop configuration (npm package):
{
"mcpServers": {
"truqu-mcp": {
"command": "npx",
"args": ["truqu-mcp", "/path/to/your/truqu-data.json"]
}
}
}
Alternative with environment variable:
{
"mcpServers": {
"truqu-mcp": {
"command": "npx",
"args": ["truqu-mcp"],
"env": {
"TRUQU_DATA_PATH": "/path/to/your/truqu-data.json"
}
}
}
}
Local development configuration:
{
"mcpServers": {
"truqu-mcp": {
"command": "npx",
"args": ["tsx", "src/index.ts", "/path/to/your/truqu-data.json"],
"cwd": "/path/to/truqu-mcp"
}
}
}
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for development setup and guidelines.
Automated Publishing
This package uses GitHub Actions for automated publishing:
- CI: Runs tests on every push/PR
- Publish: Automatically publishes to npm when a new tag is created
To release a new version:
- Update version:
npm version patch(orminor/major) - Push changes:
git push origin main --tags - GitHub Actions will automatically build and publish to npm
License
MIT
Установка Truqu
У этого сервера нет опубликованного пакета — он собирается из исходников. Открой репозиторий и следуй инструкции в README.
▸ github.com/kubilaykarpat/truqu-mcpFAQ
Truqu MCP бесплатный?
Да, Truqu MCP бесплатный — установка в пару кликов через Unyly без оплаты.
Нужен ли API-ключ для Truqu?
Нет, Truqu работает без API-ключей и переменных окружения.
Truqu — hosted или self-hosted?
Self-hosted: сервер запускается локально на твоей машине командой из раздела установки.
Как установить Truqu в Claude Desktop, Claude Code или Cursor?
Открой Truqu на unyly.org, выбери вкладку своего клиента (Claude Desktop, Claude Code, Cursor) и нажми Install — конфиг сгенерируется автоматически, без правки JSON.
Похожие MCP
GitHub
PRs, issues, code search, CI status
автор: GitHubFilesystem
Secure file operations with configurable access controls.
Memory
Knowledge graph-based persistent memory system.
Template MCP Server
A CLI tool to create a new Model Context Protocol server project with TypeScript support, dual transport options, and an extensible structure
автор: mcpdotdirectCompare Truqu with
Не уверен что выбрать?
Найди свой стек за 60 секунд
Автор?
Embed-бейдж для README
Похожее
Все в категории development
